carb/dictionary/DictionaryUtils.h

↰ Parent directory: carb/dictionary/

Utility helper functions for common dictionary operations.

Source: carb/dictionary/DictionaryUtils.h

Included By

• carb/StartupUtils.h: Contains carb::startupFramework and carb::shutdownFramework. Consider using OMNI_CORE_INIT, which invokes these methods for you in a safe manner.

• carb/events/EventsUtils.h: Helper utilities for carb::events.

Namespaces

• carb: The main Carbonite namespace.

• carb::dictionary: Undocumented.

Enums

• carb::dictionary::WalkerMode: Mode names for the ways to walk the requested dictionary.

Functions

• carb::dictionary::createDictionaryFromFile: Attempts to read the contents of a file into a dictionary.

• carb::dictionary::dumpToString: Writes a dictionary to a string.

• carb::dictionary::getCachedDictionaryInterface: helper function to retrieve the carb::dictionary::IDictionary interface.

• carb::dictionary::getChildByIndex: Prototype for a callback function used to walk children in a dictionary.

• carb::dictionary::getChildByIndex: Specialization for the carb::dictionary::getChildByIndex callback that implements a simple retrieval of the requested child item using IDictionary::getItemChildByIndex().

• carb::dictionary::getItemFullPath: Retrieves the full path to dictionary item from its top-most ancestor.

• carb::dictionary::getStringArray: Attempts to retrieve an array of string values from a given dictionary path.

• carb::dictionary::getStringArray: Attempts to retrieve an array of string values from a given dictionary path.

• carb::dictionary::getStringFromItemName: Attempts to retrieve the name of an item from a given path in a dictionary.

• carb::dictionary::getStringFromItemValue: Attempts to retrieve the value of an item from a given path in a dictionary.

• carb::dictionary::overwriteOriginalWithArrayHandling: Helper function for IDictionary::update() that ensures arrays are properly overwritten.

• carb::dictionary::saveFileFromDictionary: Writes the contents of a dictionary to a file.

• carb::dictionary::setDictionaryArrayElementFromStringValue: Parses a string representation of an array and sets it relative to a dictionary path.

• carb::dictionary::setDictionaryElementAutoType: Attempts to set a value in a dictionary with an attempt to detect the value type.

• carb::dictionary::setDictionaryFromCmdLine: Parses a set of command line arguments for dictionary items arguments and sets them.

• carb::dictionary::setDictionaryFromStringMapping: Sets a series of values in a dictionary based on keys and values in a map object.

• carb::dictionary::setStringArray: Sets an array of values at a given path relative to a dictionary item.

• carb::dictionary::setStringArray: Sets an array of values at a given path relative to a dictionary item.

• carb::dictionary::toItemType: Helper function to convert a data type to a corresponding dictionary item type.

• carb::dictionary::toItemType< bool >: Specialization for an bool item value.

• carb::dictionary::toItemType< char * >: Specialization for an char* item value.

• carb::dictionary::toItemType< const char * >: Specialization for an const char* item value.

• carb::dictionary::toItemType< double >: Specialization for an double item value.

• carb::dictionary::toItemType< float >: Specialization for an float item value.

• carb::dictionary::toItemType< int32_t >: Specialization for an int32_t item value.

• carb::dictionary::toItemType< int64_t >: Specialization for an int64_t item value.

• carb::dictionary::unsubscribeTreeFromAllEvents: Unsubscribes all items in a dictionary tree from change notifications.

• carb::dictionary::walkDictionary: Walk a dictionary item to enumerate all of its values.

Typedefs

• carb::dictionary::OnItemFn: Prototype for a callback function used to walk items in a dictionary.