Index

A

add_ut_dir_to_parent_cmake() (in module scargo.file_generators.ut_gen) add_version_to_scargo_lock() (in module scargo.config_utils) ArgumentDescriptor (class in scargo.file_generators.clang_parser.data_classes)

atsam (scargo.config.Config attribute) (scargo.config.ScargoTarget attribute) ATSAMConfig (class in scargo.config) AtsamScrips (class in scargo.target_helpers.atsam_helper)

B

bin_name (scargo.config.ProjectConfig attribute) build (scargo.config.Dependencies attribute)

build() (in module scargo.cli) build_env (scargo.config.ProjectConfig attribute) build_path (scargo.commands.check.ClangTidyChecker attribute)

C

can_fix (scargo.commands.check.CheckerFixer attribute) (scargo.commands.check.ClangFormatChecker attribute) (scargo.commands.check.CopyrightChecker attribute) (scargo.commands.check.PragmaChecker attribute) cc (scargo.config.ProfileConfig attribute) (scargo.config.ProjectConfig attribute) (scargo.config.Target attribute) (scargo.config.TestConfig attribute) cflags (scargo.config.ProfileConfig attribute) (scargo.config.ProjectConfig attribute) (scargo.config.TestConfig attribute) check (scargo.config.Config attribute) check() (in module scargo.cli) (scargo.commands.check.CheckerFixer method) (scargo.commands.check.CopyrightChecker method) check_file() (scargo.commands.check.CheckerFixer method) (scargo.commands.check.ClangFormatChecker method) (scargo.commands.check.ClangTidyChecker method) (scargo.commands.check.CopyrightChecker method) (scargo.commands.check.CppcheckChecker method) (scargo.commands.check.CyclomaticChecker method) (scargo.commands.check.PragmaChecker method) (scargo.commands.check.TodoChecker method) check_files() (scargo.commands.check.CheckerFixer method) (scargo.commands.check.CppcheckChecker method) (scargo.commands.check.CyclomaticChecker method) check_name (scargo.commands.check.CheckerFixer attribute) (scargo.commands.check.ClangFormatChecker attribute) (scargo.commands.check.ClangTidyChecker attribute) (scargo.commands.check.CopyrightChecker attribute) (scargo.commands.check.CppcheckChecker attribute) (scargo.commands.check.CyclomaticChecker attribute) (scargo.commands.check.PragmaChecker attribute) (scargo.commands.check.TodoChecker attribute) check_scargo_version() (in module scargo.config_utils) CheckConfig (class in scargo.config) CheckerFixer (class in scargo.commands.check) CheckResult (class in scargo.commands.check) ChecksConfig (class in scargo.config) chip (scargo.config.ATSAMConfig attribute) (scargo.config.Esp32Config attribute) (scargo.config.Stm32Config attribute)

chip_series (scargo.config.ATSAMConfig property) clang_format (scargo.config.ChecksConfig attribute) clang_tidy (scargo.config.ChecksConfig attribute) ClangFormatChecker (class in scargo.commands.check) ClangTidyChecker (class in scargo.commands.check) ClassDescriptor (class in scargo.file_generators.clang_parser.data_classes) clean() (in module scargo.cli) cmake_build_type (scargo.config.ProfileConfig attribute) cmake_variables (scargo.config.ProjectConfig attribute) CmdLoop (class in scargo.commands.monitor) conan (scargo.config.Config attribute) conan_add_default_profile_if_missing() (in module scargo.file_generators.conan_gen) conan_add_remote() (in module scargo.utils.conan_utils) conan_remote_login() (in module scargo.utils.conan_utils) conan_source() (in module scargo.utils.conan_utils) ConanConfig (class in scargo.config) Config (class in scargo.config) ConfigError console_log_level (scargo.config.ScargoConfig attribute) copy_file_if_not_exists() (in module scargo.commands.update) copyright (scargo.config.ChecksConfig attribute) (scargo.config.FixesConfig attribute) CopyrightChecker (class in scargo.commands.check) cppcheck (scargo.config.ChecksConfig attribute) CppcheckChecker (class in scargo.commands.check) CppCheckConfig (class in scargo.config) cpu (scargo.config.ATSAMConfig attribute) create_atsam_config() (in module scargo.target_helpers.atsam_helper) create_esp32_config() (in module scargo.target_helpers.esp32_helper) create_file_from_template() (in module scargo.file_generators.base_gen) create_stm32_config() (in module scargo.target_helpers.stm32_helper) cxx (scargo.config.ProfileConfig attribute) (scargo.config.ProjectConfig attribute) (scargo.config.Target attribute) (scargo.config.TestConfig attribute) cxxflags (scargo.config.ProfileConfig attribute) (scargo.config.ProjectConfig attribute) (scargo.config.TestConfig attribute) cxxstandard (scargo.config.ProjectConfig attribute) cyclomatic (scargo.config.ChecksConfig attribute) CyclomaticChecker (class in scargo.commands.check)

D

debug() (in module scargo.cli) default_target (scargo.config.ProjectConfig property) Dependencies (class in scargo.config) dependencies (scargo.config.Config attribute) description (scargo.config.CheckConfig attribute) (scargo.config.CppCheckConfig attribute) (scargo.config.FixConfig attribute) (scargo.config.ProjectConfig attribute) directories (scargo.config.CppCheckConfig attribute)

doc (scargo.config.Config attribute) doc() (in module scargo.cli) DocConfig (class in scargo.config) docker_build() (in module scargo.cli) docker_compose (scargo.config.Config attribute) docker_exec() (in module scargo.cli) docker_file (scargo.config.ProjectConfig attribute) docker_image_tag (scargo.config.ProjectConfig attribute) docker_run() (in module scargo.cli) DockerComposeConfig (class in scargo.config)

E

elf_file_extension (scargo.config.Target attribute) esp32 (scargo.config.Config attribute) (scargo.config.ScargoTarget attribute) Esp32Config (class in scargo.config) exclude (scargo.config.CheckConfig attribute) (scargo.config.ChecksConfig attribute) (scargo.config.CppCheckConfig attribute) (scargo.config.DocConfig attribute)

extra_component_dirs (scargo.config.Esp32Config attribute) extract_block_comments() (in module scargo.utils.file_utils) extract_classes() (in module scargo.file_generators.clang_parser.params_extractor) extract_comment_sections() (in module scargo.utils.file_utils) extract_grouped_line_comments() (in module scargo.utils.file_utils) extract_includes() (in module scargo.file_generators.clang_parser.params_extractor) extract_namespaces() (in module scargo.file_generators.clang_parser.params_extractor) extras (scargo.config.ProfileConfig property) (scargo.config.TestConfig property)

F

file_log_level (scargo.config.ScargoConfig attribute) find_files() (in module scargo.commands.check) find_program_path() (in module scargo.utils.sys_utils) finditer_with_line_numbers() (in module scargo.utils.file_utils) fix (scargo.commands.check.CheckResult attribute) (scargo.config.Config attribute) fix() (in module scargo.cli) fix_file() (scargo.commands.check.CheckerFixer method) (scargo.commands.check.ClangFormatChecker method) (scargo.commands.check.CopyrightChecker method) (scargo.commands.check.PragmaChecker method)

FixConfig (class in scargo.config) FixesConfig (class in scargo.config) flash() (in module scargo.cli) flash_start (scargo.config.Stm32Config attribute) format_problem_count() (scargo.commands.check.CheckerFixer static method) (scargo.commands.check.TodoChecker static method) FunctionDescriptor (class in scargo.file_generators.clang_parser.data_classes)

G

gcov_executable (scargo.config.TestConfig attribute) gdb_flash (scargo.target_helpers.atsam_helper.AtsamScrips attribute) gen() (in module scargo.cli) gen_fs_esp32() (in module scargo.target_helpers.esp32_helper) gen_single_binary() (in module scargo.commands.gen) gen_single_binary_esp32() (in module scargo.target_helpers.esp32_helper) general (scargo.config.Dependencies attribute) generate_certs() (in module scargo.commands.gen) generate_cicd() (in module scargo.file_generators.cicd_gen) generate_cmake() (in module scargo.file_generators.cmake_gen) generate_conanfile() (in module scargo.file_generators.conan_gen) generate_conanprofile() (in module scargo.file_generators.conan_gen) generate_cpp() (in module scargo.file_generators.cpp_gen) generate_docker_compose() (in module scargo.file_generators.docker_gen) generate_env() (in module scargo.file_generators.env_gen) generate_fs() (in module scargo.commands.gen) generate_gdb_script() (in module scargo.target_helpers.atsam_helper) generate_launch_json() (in module scargo.file_generators.vscode_gen) generate_mocks() (in module scargo.file_generators.mock_gen) generate_openocd_script() (in module scargo.target_helpers.atsam_helper) (in module scargo.target_helpers.stm32_helper) generate_readme() (in module scargo.file_generators.readme_gen) generate_tests() (in module scargo.file_generators.tests_gen) generate_toml() (in module scargo.file_generators.toml_gen) generate_ut() (in module scargo.file_generators.ut_gen) generate_vscode() (in module scargo.file_generators.vscode_gen) get_arg_names() (scargo.file_generators.clang_parser.data_classes.FunctionDescriptor method) get_arg_types() (scargo.file_generators.clang_parser.data_classes.FunctionDescriptor method)

get_atsam_config() (scargo.config.Config method) get_atsam_cpu() (in module scargo.target_helpers.atsam_helper) get_bin_dir_path() (scargo.config.Target method) get_bin_path() (scargo.config.Target method) get_build_env() (in module scargo.commands.new) get_check_config() (scargo.commands.check.CheckerFixer method) (scargo.commands.check.TodoChecker method) get_chip_target() (in module scargo.commands.new) get_comment_lines() (in module scargo.utils.clang_utils) get_conan_profile_name() (scargo.config.Target method) get_config_file_path() (in module scargo.utils.path_utils) get_directories_to_check() (scargo.commands.check.CppcheckChecker method) get_docker_compose_command() (in module scargo.commands.docker) get_esp32_config() (scargo.config.Config method) get_exclude_patterns() (scargo.commands.check.CheckerFixer method) get_logger() (in module scargo.logger) get_mock_path() (in module scargo.file_generators.mock_gen) get_openocd_flash_driver_name() (in module scargo.target_helpers.atsam_helper) get_openocd_script_name() (in module scargo.target_helpers.atsam_helper) get_profile_build_dir() (scargo.config.Target method) get_project_root_or_none() (in module scargo.utils.path_utils) get_scargo_config_or_exit() (in module scargo.config_utils) get_specifiers() (scargo.file_generators.clang_parser.data_classes.FunctionDescriptor method) get_stm32_config() (scargo.config.Config method) get_suppression_rules() (scargo.commands.check.CppcheckChecker method) get_target_by_id() (scargo.config.Target class method) get_target_or_default() (in module scargo.config_utils) get_targets_by_id() (scargo.config.Target class method) get_typed_args() (scargo.file_generators.clang_parser.data_classes.FunctionDescriptor method)

H

handle_item_deletion() (in module scargo.commands.clean) HeaderDescriptor (class in scargo.file_generators.clang_parser.data_classes)

headers_only (scargo.commands.check.CheckerFixer attribute) (scargo.commands.check.PragmaChecker attribute) homepage_url (scargo.config.ProjectConfig attribute)

I

id (scargo.config.Target attribute) in_repo_conan_cache (scargo.config.ProjectConfig attribute) include_dir_path (scargo.config.Config property) IncludeDescriptor (class in scargo.file_generators.clang_parser.data_classes) is_atsam() (scargo.config.ProjectConfig method)

is_docker_buildenv() (scargo.config.ProjectConfig method) is_esp32() (scargo.config.ProjectConfig method) is_multitarget() (scargo.config.ProjectConfig method) is_stm32() (scargo.config.ProjectConfig method) is_x86() (scargo.config.ProjectConfig method)

K

keywords (scargo.config.TodoCheckConfig attribute)

L

lib_name (scargo.config.ProjectConfig attribute)

M

max_build_jobs (scargo.config.ProjectConfig attribute) module scargo scargo.cli scargo.commands scargo.commands.build scargo.commands.check scargo.commands.clean scargo.commands.debug scargo.commands.doc scargo.commands.docker scargo.commands.fix scargo.commands.flash scargo.commands.gen scargo.commands.monitor scargo.commands.new scargo.commands.publish scargo.commands.run scargo.commands.test scargo.commands.update scargo.commands.version scargo.config scargo.config_utils scargo.file_generators scargo.file_generators.base_gen scargo.file_generators.cicd_gen scargo.file_generators.clang_parser scargo.file_generators.clang_parser.data_classes scargo.file_generators.clang_parser.header_parser scargo.file_generators.clang_parser.params_extractor scargo.file_generators.cmake_gen scargo.file_generators.conan_gen scargo.file_generators.cpp_gen scargo.file_generators.docker_gen scargo.file_generators.env_gen scargo.file_generators.mock_gen scargo.file_generators.readme_gen scargo.file_generators.tests_gen scargo.file_generators.toml_gen scargo.file_generators.ut_gen scargo.file_generators.vscode_gen scargo.global_values scargo.logger scargo.target_helpers scargo.target_helpers.atsam_helper scargo.target_helpers.esp32_helper scargo.target_helpers.stm32_helper scargo.utils scargo.utils.clang_utils scargo.utils.conan_utils scargo.utils.docker_utils scargo.utils.file_utils scargo.utils.path_utils scargo.utils.sys_utils

monitor() (in module scargo.cli)

N

name (scargo.config.ProjectConfig attribute)

NamespaceDescriptor (class in scargo.file_generators.clang_parser.data_classes) new() (in module scargo.cli)

O

openocd_cfg (scargo.target_helpers.atsam_helper.AtsamScrips attribute) (scargo.target_helpers.stm32_helper.STM32Scrips attribute)

P

parse_cmd() (scargo.commands.monitor.CmdLoop method) parse_config() (in module scargo.config) parse_file() (in module scargo.file_generators.clang_parser.header_parser) partitions (scargo.config.Esp32Config attribute) ports (scargo.config.DockerComposeConfig attribute) pragma (scargo.config.ChecksConfig attribute) PragmaChecker (class in scargo.commands.check) prepare_config() (in module scargo.config_utils) prepare_docker() (in module scargo.utils.docker_utils)

problems_found (scargo.commands.check.CheckResult attribute) process_chips() (in module scargo.commands.new) process_directory() (in module scargo.commands.clean) ProfileConfig (class in scargo.config) profiles (scargo.config.Config attribute) project (scargo.config.Config attribute) project_root (scargo.config.Config attribute) ProjectConfig (class in scargo.config) publish() (in module scargo.cli) pull_docker_image() (in module scargo.commands.update)

R

read_serial() (scargo.commands.monitor.SerialReadThread method) repo (scargo.config.ConanConfig attribute) report() (scargo.commands.check.CheckerFixer method) (scargo.commands.check.CppcheckChecker method) (scargo.commands.check.CyclomaticChecker method) run() (in module scargo.cli) (scargo.commands.monitor.CmdLoop method) (scargo.commands.monitor.SerialReadThread method)

run_command_in_docker() (in module scargo.utils.docker_utils) run_it() (in module scargo.commands.test) run_scargo_again_in_docker() (in module scargo.utils.docker_utils) run_ut() (in module scargo.commands.test)

S

scargo module scargo (scargo.config.Config attribute) scargo.cli module scargo.commands module scargo.commands.build module scargo.commands.check module scargo.commands.clean module scargo.commands.debug module scargo.commands.doc module scargo.commands.docker module scargo.commands.fix module scargo.commands.flash module scargo.commands.gen module scargo.commands.monitor module scargo.commands.new module scargo.commands.publish module scargo.commands.run module scargo.commands.test module scargo.commands.update module scargo.commands.version module scargo.config module scargo.config_utils module scargo.file_generators module scargo.file_generators.base_gen module scargo.file_generators.cicd_gen module scargo.file_generators.clang_parser module scargo.file_generators.clang_parser.data_classes module scargo.file_generators.clang_parser.header_parser module scargo.file_generators.clang_parser.params_extractor module scargo.file_generators.cmake_gen module scargo.file_generators.conan_gen module scargo.file_generators.cpp_gen module scargo.file_generators.docker_gen module scargo.file_generators.env_gen module

scargo.file_generators.mock_gen module scargo.file_generators.readme_gen module scargo.file_generators.tests_gen module scargo.file_generators.toml_gen module scargo.file_generators.ut_gen module scargo.file_generators.vscode_gen module scargo.global_values module scargo.logger module scargo.target_helpers module scargo.target_helpers.atsam_helper module scargo.target_helpers.esp32_helper module scargo.target_helpers.stm32_helper module scargo.utils module scargo.utils.clang_utils module scargo.utils.conan_utils module scargo.utils.docker_utils module scargo.utils.file_utils module scargo.utils.path_utils module scargo.utils.sys_utils module scargo_build() (in module scargo.commands.build) scargo_check() (in module scargo.commands.check) scargo_clean() (in module scargo.commands.clean) scargo_debug() (in module scargo.commands.debug) scargo_doc() (in module scargo.commands.doc) scargo_docker_build() (in module scargo.commands.docker) scargo_docker_exec() (in module scargo.commands.docker) scargo_docker_run() (in module scargo.commands.docker) scargo_fix() (in module scargo.commands.fix) scargo_flash() (in module scargo.commands.flash) scargo_gen() (in module scargo.commands.gen) scargo_monitor() (in module scargo.commands.monitor) scargo_new() (in module scargo.commands.new) scargo_publish() (in module scargo.commands.publish) scargo_run() (in module scargo.commands.run) scargo_test() (in module scargo.commands.test) scargo_update() (in module scargo.commands.update) scargo_version() (in module scargo.commands.version) ScargoConfig (class in scargo.config) ScargoTarget (class in scargo.config) SerialReadThread (class in scargo.commands.monitor) set_up_environment_variables() (in module scargo.config_utils) source_dir_path (scargo.config.Config property) stm32 (scargo.config.Config attribute) (scargo.config.ScargoTarget attribute) Stm32Config (class in scargo.config) STM32Scrips (class in scargo.target_helpers.stm32_helper) stop() (scargo.commands.monitor.CmdLoop method) (scargo.commands.monitor.SerialReadThread method) suppress (scargo.config.CppCheckConfig attribute)

T

Target (class in scargo.config) target (scargo.config.ProjectConfig property) target_id (scargo.config.ProjectConfig attribute) test (scargo.config.Dependencies attribute) test() (in module scargo.cli) TestConfig (class in scargo.config)

tests (scargo.config.Config attribute) todo (scargo.config.ChecksConfig attribute) TodoCheckConfig (class in scargo.config) TodoChecker (class in scargo.commands.check) TOO_MANY_ERROR_MESSAGE (scargo.commands.monitor.SerialReadThread attribute) tool (scargo.config.Dependencies attribute)

U

update() (in module scargo.cli)

update_exclude (scargo.config.ScargoConfig attribute)

V

validate_special_configs() (scargo.config.Config class method) version (scargo.config.ProjectConfig attribute) (scargo.config.ScargoConfig attribute)

version() (in module scargo.cli)

W

write_template() (in module scargo.file_generators.base_gen)

X

x86 (scargo.config.ScargoTarget attribute)