Getting started

Getting started may be the most challenging part of every new library. This guide is describing how to start with the library quickly and effectively

Download library

Library is primarly hosted on Github.

You can get it by:

Downloading latest release from releases area on Github
Cloning main branch for latest stable version
Cloning develop branch for latest development

Download from releases

All releases are available on Github releases area.

Clone from Github

First-time clone

This is used when you do not have yet local copy on your machine.

Make sure git is installed.
Open console and navigate to path in the system to clone repository to. Use command cd your_path
Clone repository with one of available options below
- Run git clone --recurse-submodules https://github.com/MaJerle/lwshell command to clone entire repository, including submodules
- Run git clone --recurse-submodules --branch develop https://github.com/MaJerle/lwshell to clone development branch, including submodules
- Run git clone --recurse-submodules --branch main https://github.com/MaJerle/lwshell to clone latest stable branch, including submodules
Navigate to examples directory and run favourite example

Update cloned to latest version

Open console and navigate to path in the system where your repository is located. Use command cd your_path
Run git pull origin main command to get latest changes on main branch
Run git pull origin develop command to get latest changes on develop branch
Run git submodule update --init --remote to update submodules to latest version

Note

This is preferred option to use when you want to evaluate library and run prepared examples. Repository consists of multiple submodules which can be automatically downloaded when cloning and pulling changes from root repository.

Add library to project

At this point it is assumed that you have successfully download library, either cloned it or from releases page. Next step is to add the library to the project, by means of source files to compiler inputs and header files in search path

Copy lwshell folder to your project, it contains library files
Add lwshell/src/include folder to include path of your toolchain. This is where C/C++ compiler can find the files during compilation process. Usually using -I flag
Add source files from lwshell/src/ folder to toolchain build. These files are built by C/C++ compiler. CMake configuration comes with the library, allows users to include library in the project as subdirectory and library.
Copy lwshell/src/include/lwshell/lwshell_opts_template.h to project folder and rename it to lwshell_opts.h
Build the project

Configuration file

Configuration file is used to overwrite default settings defined for the essential use case. Library comes with template config file, which can be modified according to needs. and it should be copied (or simply renamed in-place) and named lwshell_opts.h

Note

Default configuration template file location: lwshell/src/include/lwshell/lwshell_opts_template.h. File must be renamed to lwshell_opts.h first and then copied to the project directory where compiler include paths have access to it by using #include "lwshell_opts.h".

List of configuration options are available in the Configuration section. If any option is about to be modified, it should be done in configuration file

Template configuration file

/**
 * \file            lwshell_opts_template.h
 * \brief           Template config file
 */

/*
 * Copyright (c) 2023 Tilen MAJERLE
 *
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without restriction,
 * including without limitation the rights to use, copy, modify, merge,
 * publish, distribute, sublicense, and/or sell copies of the Software,
 * and to permit persons to whom the Software is furnished to do so,
 * subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE
 * AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 *
 * This file is part of LwSHELL - Lightweight shell library.
 *
 * Author:          Tilen MAJERLE <tilen@majerle.eu>
 * Version:         v1.2.0
 */
#ifndef LWSHELL_OPTS_HDR_H
#define LWSHELL_OPTS_HDR_H

/* Rename this file to "lwshell_opts.h" for your application */

/*
 * Open "include/lwshell/lwshell_opt.h" and
 * copy & replace here settings you want to change values
 */

#endif /* LWSHELL_OPTS_HDR_H */

Note

If you prefer to avoid using configuration file, application must define a global symbol LWSHELL_IGNORE_USER_OPTS, visible across entire application. This can be achieved with -D compiler option.

Minimal example code

To verify proper library setup, minimal example has been prepared. Run it in your main application file to verify its proper execution

Absolute minimum example

#include <string.h>
#include "lwshell/lwshell.h"

/* Command to get called */
int32_t
mycmd_fn(int32_t argc, char** argv) {
    printf("mycmd_fn called. Number of argv: %d\r\n", (int)argc);
    for (int32_t i = 0; i < argc; ++i) {
        printf("ARG[%d]: %s\r\n", (int)i, argv[i]);
    }

    /* Successful execution */
    return 0;
}

/* Example code */
void
example_minimal(void) {
    const char* input_str = "mycmd param1 \"param 2 with space\"\r\n";

    /* Init library */
    lwshell_init();

    /* Define shell commands */
    lwshell_register_cmd("mycmd", mycmd_fn, "Adds 2 integer numbers and prints them");

    /* User input to process every character */

    /* Now insert input */
    lwshell_input(input_str, strlen(input_str));
}