ConfigPage

class ConfigPage

A page of ConfigDeclarations that may be loaded or unloaded. Typically this represents a single .prc file that is read from disk at runtime, but it may also represent a list of declarations built up by application code and explicitly loaded.

Inheritance diagram

void clear(void)

Removes all of the declarations from the page.

bool delete_declaration(ConfigDeclaration *decl)

Removes the indicated declaration from the page and deletes it. Returns true if the declaration is successfully removed, false if it was not on the page.

ConfigDeclaration const *get_declaration(std::size_t n) const

Returns the nth declaration on the page.

static ConfigPage *get_default_page(void)

Returns a pointer to the global “default page”. This is the ConfigPage that lists all variables’ original default values.

static ConfigPage *get_local_page(void)

Returns a pointer to the global “local page”. This is the ConfigPage that lists the locally-assigned values for any variables in the world that have such a local assignment.

std::string const &get_name(void) const

Returns the name of the page. If the page was loaded from a .prc file, this is usually the filename.

std::size_t get_num_declarations(void) const

Returns the number of declarations on the page.

int get_page_seq(void) const

Returns the sequence number of the page.

Sequence numbers for a particular class (implicit vs. explicit) of pages are assigned as each page is loaded; each page is given a higher sequence number than all the pages loaded before it.

The implicit_load pages, which are discovered in the file system automatically, have a different set of sequence numbers than the explicit pages.

std::string const &get_signature(void) const

Returns the raw binary signature that was found in the prc file, if any. This method is probably not terribly useful for most applications.

int get_sort(void) const

Returns the explicit sort order of this particular ConfigPage. See set_sort().

std::string get_string_value(std::size_t n) const

Returns the value assigned by the nth declaration on the page.

int get_trust_level(void) const

Returns the trust level associated with this page. An untrusted page is trust level 0; if the page was loaded from a signed .prc file, its trust level is the index number of the certificate that signed it. Generally, a higher trust level value represents a greater level of trust.

std::string get_variable_name(std::size_t n) const

Returns the variable named by the nth declaration on the page.

bool is_implicit(void) const

Returns true if the page was loaded by implicitly searching the config path on startup, or false if it was explicitly loaded by dynamic code after initial startup.

bool is_special(void) const

Returns true if this is the special “default” or “local” page, or false if it is an ordinary page, e.g. an implicit page loaded from a prc file at startup, or an explicit page created by ConfigPageManager::make_explicit_page().

bool is_variable_used(std::size_t n) const

Returns true if the nth active variable on the page has been used by code, false otherwise.

ConfigDeclaration *make_declaration(std::string const &variable, std::string const &value)

ConfigDeclaration *make_declaration(ConfigVariableCore *variable, std::string const &value)

Adds the indicated variable/value pair as a new declaration on the page.

ConfigDeclaration *modify_declaration(std::size_t n)

Returns a modifiable pointer to the nth declaration on the page. Any modifications will appear in the output, if the page is written out with ConfigPage::write().

void output(std::ostream &out) const

void output_brief_signature(std::ostream &out) const

Outputs the first few hex digits of the signature.

bool read_encrypted_prc(std::istream &in, std::string const &password)

Automatically decrypts and reads the stream, given the indicated password. Note that if the password is incorrect, the result may be garbage.

bool read_prc(std::istream &in)

Reads the contents of a complete prc file, as returned by the indicated istream, into the current page file. Returns true on success, or false on some I/O error.

This is a low-level interface. Normally you do not need to call it directly. See the global functions load_prc_file() and unload_prc_file(), defined in panda/src/putil, for a higher-level interface.

void set_sort(int sort)

Changes the explicit sort order of this particular ConfigPage. Lower- numbered pages supercede higher-numbered pages. Initially, all explicitly- loaded pages have sort value 0, and implicitly-loaded pages (found on disk) have sort value 10; you may set an individual page higher or lower to influence its priority relative to other pages.

void set_trust_level(int trust_level)

Explicitly sets the trust level on this particular page. Note that any subsequent changes to the page, or to any variable declarations on it, will reset the trust level to zero.

void write(std::ostream &out) const