#include </home/runner/work/OrcaSlicer/OrcaSlicer/src/libslic3r/PrintConfig.hpp>

Inheritance diagram for Slic3r::CLIMiscConfigDef:

Collaboration diagram for Slic3r::CLIMiscConfigDef:

Public Member Functions
	CLIMiscConfigDef ()
bool	has (const t_config_option_key &opt_key) const
const ConfigOptionDef *	get (const t_config_option_key &opt_key) const
std::vector< std::string >	keys () const
bool	empty ()
std::ostream &	print_cli_help (std::ostream &out, bool show_defaults, std::function< bool(const ConfigOptionDef &)> filter=[](const ConfigOptionDef &){ return true;}) const

Public Attributes
t_optiondef_map	options
std::map< size_t, const ConfigOptionDef * >	by_serialization_key_ordinal

Protected Member Functions
ConfigOptionDef *	add (const t_config_option_key &opt_key, ConfigOptionType type)
ConfigOptionDef *	add_nullable (const t_config_option_key &opt_key, ConfigOptionType type)

Detailed Description

Constructor & Destructor Documentation

◆ CLIMiscConfigDef()

Slic3r::CLIMiscConfigDef::CLIMiscConfigDef ( )

{
    ConfigOptionDef* def;
 
    /*def = this->add("ignore_nonexistent_config", coBool);
    def->label = L("Ignore non-existent config files");
    def->tooltip = L("Do not fail if a file supplied to --load does not exist.");
 
    def = this->add("config_compatibility", coEnum);
    def->label = L("Forward-compatibility rule when loading configurations from config files and project files (3MF, AMF).");
    def->tooltip = L("This version of OrcaSlicer may not understand configurations produced by the newest OrcaSlicer versions. "
                     "For example, newer OrcaSlicer may extend the list of supported firmware flavors. One may decide to "
                     "bail out or to substitute an unknown value with a default silently or verbosely.");
    def->enum_keys_map = &ConfigOptionEnum<ForwardCompatibilitySubstitutionRule>::get_enum_values();
    def->enum_values.push_back("disable");
    def->enum_values.push_back("enable");
    def->enum_values.push_back("enable_silent");
    def->enum_labels.push_back(L("Bail out on unknown configuration values"));
    def->enum_labels.push_back(L("Enable reading unknown configuration values by verbosely substituting them with defaults."));
    def->enum_labels.push_back(L("Enable reading unknown configuration values by silently substituting them with defaults."));
    def->set_default_value(new ConfigOptionEnum<ForwardCompatibilitySubstitutionRule>(ForwardCompatibilitySubstitutionRule::Enable));*/
 
    /*def = this->add("load", coStrings);
    def->label = L("Load config file");
    def->tooltip = L("Load configuration from the specified file. It can be used more than once to load options from multiple files.");*/
 
    def = this->add("load_settings", coStrings);
    def->label = L("Load General Settings");
    def->tooltip = L("Load process/machine settings from the specified file.");
    def->cli_params = "\"setting1.json;setting2.json\"";
    def->set_default_value(new ConfigOptionStrings());
 
    def = this->add("load_filaments", coStrings);
    def->label = L("Load Filament Settings");
    def->tooltip = L("Load filament settings from the specified file list.");
    def->cli_params = "\"filament1.json;filament2.json;...\"";
    def->set_default_value(new ConfigOptionStrings());
 
    def = this->add("skip_objects", coInts);
    def->label = L("Skip Objects");
    def->tooltip = L("Skip some objects in this print.");
    def->cli_params = "\"3,5,10,77\"";
    def->set_default_value(new ConfigOptionInts());
 
    def = this->add("clone_objects", coInts);
    def->label = L("Clone Objects");
    def->tooltip = L("Clone objects in the load list.");
    def->cli_params = "\"1,3,1,10\"";
    def->set_default_value(new ConfigOptionInts());
 
    def = this->add("uptodate_settings", coStrings);
    def->label = L("Load uptodate process/machine settings when using uptodate");
    def->tooltip = L("load up-to-date process/machine settings from the specified file when using up-to-date");
    def->cli_params = "\"setting1.json;setting2.json\"";
    def->set_default_value(new ConfigOptionStrings());
 
    def = this->add("uptodate_filaments", coStrings);
    def->label = L("Load uptodate filament settings when using uptodate");
    def->tooltip = L("Load uptodate filament settings from the specified file when using uptodate.");
    def->cli_params = "\"filament1.json;filament2.json;...\"";
    def->set_default_value(new ConfigOptionStrings());
 
    def = this->add("downward_check", coBool);
    def->label = L("Downward machines check");
    def->tooltip = L("If enabled, check whether current machine downward compatible with the machines in the list.");
    def->set_default_value(new ConfigOptionBool(false));
 
    def = this->add("downward_settings", coStrings);
    def->label = L("Downward machines settings");
    def->tooltip = L("The machine settings list needs to do downward checking.");
    def->cli_params = "\"machine1.json;machine2.json;...\"";
    def->set_default_value(new ConfigOptionStrings());
 
    def = this->add("load_assemble_list", coString);
    def->label = L("Load assemble list");
    def->tooltip = L("Load assemble object list from config file.");
    def->cli_params = "assemble_list.json";
    def->set_default_value(new ConfigOptionString());
 
    /*def = this->add("output", coString);
    def->label = L("Output File");
    def->tooltip = L("The file where the output will be written (if not specified, it will be based on the input file).");
    def->cli = "output|o";
 
    def = this->add("single_instance", coBool);
    def->label = L("Single instance mode");
    def->tooltip = L("If enabled, the command line arguments are sent to an existing instance of GUI OrcaSlicer, "
                     "or an existing OrcaSlicer window is activated. "
                     "Overrides the \"single_instance\" configuration value from application preferences.");*/
 
/*
    def = this->add("autosave", coString);
    def->label = L("Autosave");
    def->tooltip = L("Automatically export current configuration to the specified file.");
*/
 
    def = this->add("datadir", coString);
    def->label = L("Data directory");
    def->tooltip = L("Load and store settings at the given directory. This is useful for maintaining different profiles or including configurations from a network storage.");
 
 
    def = this->add("outputdir", coString);
    def->label = L("Output directory");
    def->tooltip = L("This is the output directory for exported files.");
    def->cli_params = "dir";
    def->set_default_value(new ConfigOptionString());
 
    def = this->add("export_statistics", coBool);
    def->label = L("Export statistics");
    def->tooltip = L("Write the statistics of each sliced plate as JSON, as plate_N.statistics.json next to its G-code in the output "
                     "directory and inside the 3MF of --export-3mf: print time, filament and feature totals, and the same per layer "
                     "and per object.");
    def->set_default_value(new ConfigOptionBool(false));
 
    def = this->add("debug", coInt);
    def->label = L("Debug level");
    def->tooltip = L("Sets debug logging level. 0:fatal, 1:error, 2:warning, 3:info, 4:debug, 5:trace\n");
    def->min = 0;
    def->cli_params = "level";
    def->set_default_value(new ConfigOptionInt(1));
 
    def = this->add("logfile", coString);
    def->label = L("Log file");
    def->tooltip = L("Redirects debug logging to file.\n");
    def->cli_params = "file";
    def->set_default_value(new ConfigOptionString());
 
    def = this->add("enable_timelapse", coBool);
    def->label = L("Enable timelapse for print");
    def->tooltip = L("If enabled, this slicing will be considered using timelapse.");
    def->set_default_value(new ConfigOptionBool(false));
 
#if (defined(_MSC_VER) || defined(__MINGW32__)) && defined(SLIC3R_GUI)
    /*def = this->add("sw_renderer", coBool);
    def->label = L("Render with a software renderer");
    def->tooltip = L("Render with a software renderer. The bundled MESA software renderer is loaded instead of the default OpenGL driver.");
    def->min = 0;*/
#endif /* _MSC_VER */
 
    def = this->add("load_custom_gcodes", coString);
    def->label = L("Load custom G-code");
    def->tooltip = L("Load custom G-code from json.");
    def->cli_params = "custom_gcode_toolchange.json";
    def->set_default_value(new ConfigOptionString());
 
    def = this->add("load_filament_ids", coInts);
    def->label = L("Load filament IDs");
    def->tooltip = L("Load filament IDs for each object.");
    def->cli_params = "\"1,2,3,1\"";
    def->set_default_value(new ConfigOptionInts());
 
    def = this->add("allow_multicolor_oneplate", coBool);
    def->label = L("Allow multiple colors on one plate");
    def->tooltip = L("If enabled, Arrange will allow multiple colors on one plate.");
    def->set_default_value(new ConfigOptionBool(true));
 
    def = this->add("allow_rotations", coBool);
    def->label = L("Allow rotation when arranging");
    def->tooltip = L("If enabled, Arrange will allow rotation when placing objects.");
    def->set_default_value(new ConfigOptionBool(false));
 
    def = this->add("align_to_y_axis", coBool);
    def->label = L("Align to Y axis when arranging");
    def->tooltip = L("If enabled, Arrange will turn each object so its long side runs along the Y axis before placing it. "
                     "When not given, it is on for i3 printers and off for the others, as in the GUI.");
    def->set_default_value(new ConfigOptionBool(false));
 
    def = this->add("avoid_extrusion_cali_region", coBool);
    def->label = L("Avoid extrusion calibrate region when arranging");
    def->tooltip = L("If enabled, Arrange will avoid extrusion calibrate region when placing objects.");
    def->set_default_value(new ConfigOptionBool(false));
 
    def = this->add("skip_modified_gcodes", coBool);
    def->label = L("Skip modified G-code in 3MF");
    def->tooltip = L("Skip the modified G-code in 3MF from printer or filament presets.");
    def->set_default_value(new ConfigOptionBool(false));
 
    def = this->add("makerlab_name", coString);
    def->label = L("MakerLab name");
    def->tooltip = L("MakerLab name to generate this 3MF.");
    def->cli_params = "name";
    def->set_default_value(new ConfigOptionString());
 
    def = this->add("makerlab_version", coString);
    def->label = L("MakerLab version");
    def->tooltip = L("MakerLab version to generate this 3MF.");
    def->cli_params = "version";
    def->set_default_value(new ConfigOptionString());
 
    def = this->add("metadata_name", coStrings);
    def->label = L("Metadata name list");
    def->tooltip = L("Metadata name list added into 3MF.");
    def->cli_params = "\"name1;name2;...\"";
    def->set_default_value(new ConfigOptionStrings());
 
    def = this->add("metadata_value", coStrings);
    def->label = L("Metadata value list");
    def->tooltip = L("Metadata value list added into 3MF.");
    def->cli_params = "\"value1;value2;...\"";
    def->set_default_value(new ConfigOptionStrings());
 
    def = this->add("allow_newer_file", coBool);
    def->label = L("Allow 3MF with newer version to be sliced");
    def->tooltip = L("Allow 3MF with newer version to be sliced.");
    def->set_default_value(new  ConfigOptionBool(false));
 
    def = this->add("allow_mix_temp", coBool);
    // internal use only, don't need translation
    def->label = "Allow filaments with high/low temperature to be printed together";
    def->tooltip = "Allow filaments with high/low temperature to be printed together.";
    def->set_default_value(new  ConfigOptionBool(false));
}

References Slic3r::ConfigDef::add(), Slic3r::ConfigOptionDef::cli_params, Slic3r::coBool, Slic3r::coInt, Slic3r::coInts, Slic3r::ConfigOptionString, Slic3r::coString, Slic3r::coStrings, L, Slic3r::ConfigOptionDef::label, Slic3r::ConfigOptionDef::min, Slic3r::ConfigOptionDef::set_default_value(), and Slic3r::ConfigOptionDef::tooltip.

Here is the call graph for this function:

Member Function Documentation

◆ add()

ConfigOptionDef * Slic3r::ConfigDef::add	(	const t_config_option_key &	opt_key,
		ConfigOptionType	type )

protectedinherited

{
  static size_t serialization_key_ordinal_last = 0;
    ConfigOptionDef *opt = &this->options[opt_key];
    opt->opt_key = opt_key;
    opt->type = type;
    opt->serialization_key_ordinal = ++ serialization_key_ordinal_last;
    this->by_serialization_key_ordinal[opt->serialization_key_ordinal] = opt;
    return opt;
}

References by_serialization_key_ordinal, and options.

Here is the caller graph for this function:

◆ add_nullable()

ConfigOptionDef * Slic3r::ConfigDef::add_nullable	(	const t_config_option_key &	opt_key,
		ConfigOptionType	type )

protectedinherited

{
  ConfigOptionDef *def = this->add(opt_key, type);
  def->nullable = true;
  return def;
}

References add(), and Slic3r::ConfigOptionDef::nullable.

Referenced by Slic3r::PrintConfigDef::init_fff_params().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ empty()

bool Slic3r::ConfigDef::empty ( )

inlineinherited

2673{ return options.empty(); }

References options.

◆ get()

const ConfigOptionDef * Slic3r::ConfigDef::get ( const t_config_option_key & opt_key ) const

inlineinherited

                                                                          {
        t_optiondef_map::iterator it = const_cast<ConfigDef*>(this)->options.find(opt_key);
        return (it == this->options.end()) ? nullptr : &it->second;
    }

References options.

Referenced by Slic3r::GUI::change_opt_value(), Slic3r::StaticPrintConfig::StaticCache< T >::finalize(), Slic3r::CalibPressureAdvance::find_optimal_PA_speed(), Slic3r::anonymous_namespace{PluginResolver.cpp}::find_option_for_capability(), Slic3r::GUI::SettingsFactory::get_bundle(), Slic3r::GUI::ConfigOptionsGroup::get_config_value(), Slic3r::GUI::ConfigOptionsGroup::get_config_value2(), Slic3r::GUI::get_full_label(), Slic3r::GUI::get_full_settings_hierarchy(), Slic3r::GUI::get_string_value(), Slic3r::PrintConfigDef::handle_legacy_composite(), Slic3r::ConfigBase::load_from_json(), Slic3r::prune_stale_plugin_overrides(), Slic3r::DynamicPrintConfig::update_filament_config_values_for_multiple_extruders(), Slic3r::GUI::Sidebar::update_presets(), Slic3r::DynamicPrintConfig::update_values_from_multi_to_multi(), Slic3r::DynamicPrintConfig::update_values_from_multi_to_multi_2(), Slic3r::DynamicPrintConfig::update_values_from_single_to_multi(), Slic3r::DynamicPrintConfig::update_values_to_printer_extruders(), and Slic3r::DynamicPrintConfig::update_values_to_printer_extruders_for_multiple_filaments().

Here is the caller graph for this function:

◆ has()

bool Slic3r::ConfigDef::has ( const t_config_option_key & opt_key ) const

inlineinherited

2661{ return this->options.count(opt_key) > 0; }

Referenced by Slic3r::GUI::EditGCodeDialog::selection_changed().

Here is the caller graph for this function:

◆ keys()

std::vector< std::string > Slic3r::ConfigDef::keys ( ) const

inlineinherited

                                      {
        std::vector<std::string> out;
        out.reserve(options.size());
        for(auto const& kvp : options)
            out.push_back(kvp.first);
        return out;
    }

References options.

◆ print_cli_help()

std::ostream & Slic3r::ConfigDef::print_cli_help	(	std::ostream &	out,
		bool	show_defaults,
		std::function< bool(const ConfigOptionDef &)>	filter = [](const ConfigOptionDef &){ return true; } ) const

inherited

{
    // prepare a function for wrapping text
    auto wrap = [](std::string text, size_t line_length) -> std::string {
        std::istringstream words(text);
        std::ostringstream wrapped;
        std::string word;
 
        if (words >> word) {
            wrapped << word;
            size_t space_left = line_length - word.length();
            while (words >> word) {
                if (space_left < word.length() + 1) {
                    wrapped << '\n' << word;
                    space_left = line_length - word.length();
                } else {
                    wrapped << ' ' << word;
                    space_left -= word.length() + 1;
                }
            }
        }
        return wrapped.str();
    };
 
    // get the unique categories
    std::set<std::string> categories;
    for (const auto& opt : this->options) {
        const ConfigOptionDef& def = opt.second;
        if (filter(def))
            categories.insert(def.category);
    }
 
    for (auto category : categories) {
        if (category != "") {
            out << category << ":" << std::endl;
        } else if (categories.size() > 1) {
            out << "Misc options:" << std::endl;
        }
 
        for (const auto& opt : this->options) {
            const ConfigOptionDef& def = opt.second;
      if (def.category != category || def.cli == ConfigOptionDef::nocli || !filter(def))
                continue;
 
            // get all possible variations: --foo, --foobar, -f...
            std::vector<std::string> cli_args = def.cli_args(opt.first);
      if (cli_args.empty())
        continue;
 
            for (auto& arg : cli_args) {
                arg.insert(0, (arg.size() == 1) ? "-" : "--");
                //BBS: refine the print help format
                if (!def.cli_params.empty())
                    arg += " " + def.cli_params;
                /*if ( def.type == coInt || def.type == coInts) {
                    arg += " int_value";
                } else if (def.type == coFloat ||  def.type == coFloatOrPercent || def.type == coFloats) {
                    arg += " float_value";
                } else if (def.type == coPoint) {
                    arg += " X,Y";
                } else if (def.type == coPoint3) {
                    arg += " X,Y,Z";
                } else if (def.type == coString || def.type == coStrings) {
                    arg += " filename_lists";
                }*/
            }
 
            // left: command line options
            const std::string cli = boost::algorithm::join(cli_args, ", ");
            out << " " << std::left << std::setw(20) << cli;
 
            // right: option description
            std::string descr = def.tooltip;
            bool show_defaults_this = show_defaults || def.opt_key == "config_compatibility";
            if (show_defaults_this && def.default_value && def.type != coBool
                && (def.type != coString || !def.default_value->serialize().empty())) {
                descr += " (";
                if (!def.sidetext.empty()) {
                    descr += def.sidetext + ", ";
                } else if (!def.enum_values.empty()) {
                    descr += boost::algorithm::join(def.enum_values, ", ") + "; ";
                }
                descr += "default: " + def.default_value->serialize() + ")";
            }
 
            // wrap lines of description
            descr = wrap(descr, 80);
            std::vector<std::string> lines;
            boost::split(lines, descr, boost::is_any_of("\n"));
 
            // if command line options are too long, print description in new line
            for (size_t i = 0; i < lines.size(); ++i) {
                if (i == 0 && cli.size() > 19)
                    out << std::endl;
                if (i > 0 || cli.size() > 19)
                    out << std::string(21, ' ');
                out << lines[i] << std::endl;
            }
        }
    }
    return out;
}

References Slic3r::ConfigOptionDef::category, Slic3r::ConfigOptionDef::cli, Slic3r::ConfigOptionDef::cli_args(), Slic3r::ConfigOptionDef::cli_params, Slic3r::coBool, Slic3r::coString, Slic3r::ConfigOptionDef::default_value, Slic3r::ConfigOptionDef::enum_values, Slic3r::ConfigOptionDef::nocli, Slic3r::ConfigOptionDef::opt_key, options, Slic3r::ConfigOptionDef::sidetext, Slic3r::ConfigOptionDef::tooltip, and Slic3r::ConfigOptionDef::type.

Here is the call graph for this function:

Member Data Documentation

◆ by_serialization_key_ordinal

std::map<size_t, const ConfigOptionDef*> Slic3r::ConfigDef::by_serialization_key_ordinal

inherited

Referenced by Slic3r::DynamicPrintAndCLIConfig::PrintAndCLIConfigDef::PrintAndCLIConfigDef(), and add().

◆ options

t_optiondef_map Slic3r::ConfigDef::options

inherited

Referenced by Slic3r::DynamicPrintAndCLIConfig::PrintAndCLIConfigDef::PrintAndCLIConfigDef(), Slic3r::PrintConfigDef::PrintConfigDef(), Slic3r::DynamicPrintAndCLIConfig::PrintAndCLIConfigDef::~PrintAndCLIConfigDef(), add(), Slic3r::Search::SettingsIndex::append_options(), empty(), Slic3r::StaticPrintConfig::StaticCache< T >::finalize(), get(), Slic3r::GUI::get_string_from_enum(), Slic3r::PrintConfigDef::init_fff_params(), keys(), Slic3r::ConfigBase::load_from_json(), print_cli_help(), and Slic3r::DynamicConfig::read_cli().

The documentation for this class was generated from the following files:

/home/runner/work/OrcaSlicer/OrcaSlicer/src/libslic3r/PrintConfig.hpp
/home/runner/work/OrcaSlicer/OrcaSlicer/src/libslic3r/PrintConfig.cpp

Public Member Functions

Public Attributes

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ CLIMiscConfigDef()

Member Function Documentation

◆ add()

◆ add_nullable()

◆ empty()

◆ get()

◆ has()

◆ keys()

◆ print_cli_help()

Member Data Documentation

◆ by_serialization_key_ordinal

◆ options