Internals

The Internals module contains types that are internals, or private implementation details of the library. More...

Classes
class	LibSgfcPlusPlus::SgfcComposedPropertyValue
	The SgfcComposedPropertyValue class provides an implementation of the ISgfcComposedPropertyValue interface. See the interface header file for documentation. More...
class	LibSgfcPlusPlus::SgfcDocument
	The SgfcDocument class provides an implementation of the ISgfcDocument interface. See the interface header file for documentation. More...
class	LibSgfcPlusPlus::SgfcGame
	The SgfcGame class provides an implementation of the ISgfcGame interface. See the interface header file for documentation. More...
class	LibSgfcPlusPlus::SgfcNode
	The SgfcNode class provides an implementation of the ISgfcNode interface. See the interface header file for documentation. More...
class	LibSgfcPlusPlus::SgfcNodeIterator
	The SgfcNodeIterator class encapsulates reusable algorithms for iterating over a tree of ISgfcNode objects. More...
class	LibSgfcPlusPlus::SgfcProperty
	The SgfcProperty class provides an implementation of the ISgfcProperty interface. See the interface header file for documentation. More...
class	LibSgfcPlusPlus::SgfcPropertyMetaInfo
	The SgfcPropertyMetaInfo class provides meta information about a property and the values it can have according to the SGF standard. More...
class	LibSgfcPlusPlus::SgfcSinglePropertyValue
	The SgfcSinglePropertyValue class provides an implementation of the ISgfcSinglePropertyValue interface. See the interface header file for documentation. More...
class	LibSgfcPlusPlus::SgfcTreeBuilder
	The SgfcTreeBuilder class provides an implementation of the ISgfcTreeBuilder interface. See the interface header file for documentation. More...
class	LibSgfcPlusPlus::SgfcBoardSizeProperty
	The SgfcBoardSizeProperty class provides an implementation of the ISgfcBoardSizeProperty interface. See the interface header file for documentation. More...
class	LibSgfcPlusPlus::SgfcGameTypeProperty
	The SgfcGameTypeProperty class provides an implementation of the ISgfcGameTypeProperty interface. See the interface header file for documentation. More...
class	LibSgfcPlusPlus::SgfcGoMovePropertyValue
	The SgfcGoMovePropertyValue class provides an implementation of the ISgfcGoMovePropertyValue interface. See the interface header file for documentation. More...
class	LibSgfcPlusPlus::SgfcGoPointPropertyValue
	The SgfcGoPointPropertyValue class provides an implementation of the ISgfcGoPointPropertyValue interface. See the interface header file for documentation. More...
class	LibSgfcPlusPlus::SgfcGoStonePropertyValue
	The SgfcGoStonePropertyValue class provides an implementation of the ISgfcGoStonePropertyValue interface. See the interface header file for documentation. More...
class	LibSgfcPlusPlus::SgfcColorPropertyValue
	The SgfcColorPropertyValue class provides an implementation of the ISgfcColorPropertyValue interface. See the interface header file for documentation. More...
class	LibSgfcPlusPlus::SgfcDoublePropertyValue
	The SgfcDoublePropertyValue class provides an implementation of the ISgfcDoublePropertyValue interface. See the interface header file for documentation. More...
class	LibSgfcPlusPlus::SgfcMovePropertyValue
	The SgfcMovePropertyValue class provides an implementation of the ISgfcMovePropertyValue interface. See the interface header file for documentation. More...
class	LibSgfcPlusPlus::SgfcNumberPropertyValue
	The SgfcNumberPropertyValue class provides an implementation of the ISgfcNumberPropertyValue interface. See the interface header file for documentation. More...
class	LibSgfcPlusPlus::SgfcPointPropertyValue
	The SgfcPointPropertyValue class provides an implementation of the ISgfcPointPropertyValue interface. See the interface header file for documentation. More...
class	LibSgfcPlusPlus::SgfcRealPropertyValue
	The SgfcRealPropertyValue class provides an implementation of the ISgfcRealPropertyValue interface. See the interface header file for documentation. More...
class	LibSgfcPlusPlus::SgfcSimpleTextPropertyValue
	The SgfcSimpleTextPropertyValue class provides an implementation of the ISgfcSimpleTextPropertyValue interface. See the interface header file for documentation. More...
class	LibSgfcPlusPlus::SgfcStonePropertyValue
	The SgfcStonePropertyValue class provides an implementation of the ISgfcStonePropertyValue interface. See the interface header file for documentation. More...
class	LibSgfcPlusPlus::SgfcTextPropertyValue
	The SgfcTextPropertyValue class provides an implementation of the ISgfcTextPropertyValue interface. See the interface header file for documentation. More...
class	LibSgfcPlusPlus::SgfcPropertyFactory
	The SgfcPropertyFactory class provides an implementation of the ISgfcPropertyFactory interface. See the interface header file for documentation. More...
class	LibSgfcPlusPlus::SgfcPropertyValueFactory
	The SgfcPropertyValueFactory class provides an implementation of the ISgfcPropertyValueFactory interface. See the interface header file for documentation. More...
class	LibSgfcPlusPlus::SgfcGoGameInfo
	The SgfcGoGameInfo class provides an implementation of the ISgfcGoGameInfo interface. See the interface header file for documentation. More...
class	LibSgfcPlusPlus::SgfcGoMove
	The SgfcGoMove class provides an implementation of the ISgfcGoMove interface. See the interface header file for documentation. More...
class	LibSgfcPlusPlus::SgfcGoPoint
	The SgfcGoPoint class provides an implementation of the ISgfcGoPoint interface. See the interface header file for documentation. More...
class	LibSgfcPlusPlus::SgfcGoStone
	The SgfcGoStone class provides an implementation of the ISgfcGoStone interface. See the interface header file for documentation. More...
class	LibSgfcPlusPlus::SgfcGameInfo
	The SgfcGameInfo class provides an implementation of the ISgfcGameInfo interface. See the interface header file for documentation. More...
class	LibSgfcPlusPlus::SgfcGameUtility
	The SgfcGameUtility class is a container for static helper functions related to game logic. More...
class	LibSgfcPlusPlus::ISgfcPropertyValueTypeDescriptor
	The ISgfcPropertyValueTypeDescriptor interface provides a description of the potential types of values that a specific SGF property can have in the raw SGF content. This information helps with parsing the raw SGF property value string. More...
class	LibSgfcPlusPlus::SgfcPropertyBasicValueTypeDescriptor
	The SgfcPropertyBasicValueTypeDescriptor class provides an implementation of the ISgfcPropertyValueTypeDescriptor interface. See the interface header file for documentation. More...
class	LibSgfcPlusPlus::SgfcPropertyComposedValueTypeDescriptor
	The SgfcPropertyComposedValueTypeDescriptor class provides an implementation of the ISgfcPropertyValueTypeDescriptor interface. See the interface header file for documentation. More...
class	LibSgfcPlusPlus::SgfcPropertyDualValueTypeDescriptor
	The SgfcPropertyDualValueTypeDescriptor class provides an implementation of the ISgfcPropertyValueTypeDescriptor interface. See the interface header file for documentation. More...
class	LibSgfcPlusPlus::SgfcPropertyElistValueTypeDescriptor
	The SgfcPropertyElistValueTypeDescriptor class provides an implementation of the ISgfcPropertyValueTypeDescriptor interface. See the interface header file for documentation. More...
class	LibSgfcPlusPlus::SgfcPropertyListValueTypeDescriptor
	The SgfcPropertyListValueTypeDescriptor class provides an implementation of the ISgfcPropertyValueTypeDescriptor interface. See the interface header file for documentation. More...
class	LibSgfcPlusPlus::SgfcDocumentEncoder
	The SgfcDocumentEncoder class encodes the content of an ISgfcDocument object into an in-memory string buffer that contains the SGF content stream as if it were read from an .sgf file, and that can be passed to SGFC for further processing (corrections and/or writing to an .sgf file in the filesystem). More...
class	LibSgfcPlusPlus::SgfcPropertyDecoder
	The SgfcPropertyDecoder class parses the raw strings that SGFC provides for SGF properties and their values, and generates proper objects from those parsing activities. More...
class	LibSgfcPlusPlus::SgfcPropertyValueTypeDescriptorConstants
	The SgfcPropertyValueTypeDescriptorConstants class is a container class for library-internal property value type descriptor constants. More...
class	LibSgfcPlusPlus::SgfcValueConverter
	The SgfcValueConverter class converts raw string values into value types defined by the SGF standard, and vice versa. More...
class	LibSgfcPlusPlus::SgfcArgument
	The SgfcArgument class provides an implementation of the ISgfcArgument interface. See the interface header file for documentation. More...
class	LibSgfcPlusPlus::SgfcArguments
	The SgfcArguments class provides an implementation of the ISgfcArguments interface. See the interface header file for documentation. More...
class	LibSgfcPlusPlus::SgfcBackendController
	The SgfcBackendController class encapsuslates the SGFC backend and is responsible for coordinating access to it. More...
class	LibSgfcPlusPlus::SgfcBackendDataWrapper
	The SgfcBackendDataWrapper class is a wrapper around the SGFInfo data structure that is defined by the SGFC backend. SgfcBackendDataWrapper is responsible for managing the memory of an SGFInfo object. More...
class	LibSgfcPlusPlus::SgfcBackendLoadResult
	The SgfcBackendLoadResult class provides access to the result of a load operation performed by SgfcBackendController. More...
class	LibSgfcPlusPlus::SgfcBackendSaveResult
	The SgfcBackendSaveResult class provides access to the result of a save operation performed by SgfcBackendController. More...
class	LibSgfcPlusPlus::SgfcOptions
	The SgfcOptions class is used to capture a snapshot of the option values in an SGFCOptions struct, and to reconfigure an SGFCOptions struct with those captured values at a later time. More...
class	LibSgfcPlusPlus::SgfcCommandLine
	The SgfcCommandLine class provides an implementation of the ISgfcCommandLine interface. See the interface header file for documentation. More...
class	LibSgfcPlusPlus::SgfcDocumentReader
	The SgfcDocumentReader class provides an implementation of the ISgfcDocumentReader interface. See the interface header file for documentation. More...
class	LibSgfcPlusPlus::SgfcDocumentReadResult
	The SgfcDocumentReadResult class provides an implementation of the ISgfcDocumentReadResult interface. See the interface header file for documentation. More...
class	LibSgfcPlusPlus::SgfcDocumentWriter
	The SgfcDocumentWriter class provides an implementation of the ISgfcDocumentWriter interface. See the interface header file for documentation. More...
class	LibSgfcPlusPlus::SgfcDocumentWriteResult
	The SgfcDocumentWriteResult class provides an implementation of the ISgfcDocumentWriteResult interface. See the interface header file for documentation. More...
class	LibSgfcPlusPlus::SgfcMessage
	The SgfcMessage class provides an implementation of the ISgfcMessage interface. See the interface header file for documentation. More...
class	LibSgfcPlusPlus::SgfcMessageStream
	The SgfcMessageStream class captures the stream of messages that is generated by SGFC. More...
class	LibSgfcPlusPlus::SgfcSaveStream
	The SgfcSaveStream class captures the stream of save data that is generated by SGF. More...
class	LibSgfcPlusPlus::SgfcSgfContent
	The SgfcSgfContent class represents a distinct piece of SGF content that is generated by SGFC when it performs a save operation. SgfcSgfContent objects are immutable. More...
class	LibSgfcPlusPlus::SgfcPrivateConstants
	The SgfcPrivateConstants class is a container class for library-internal constants. More...
class	LibSgfcPlusPlus::SgfcUtility
	The SgfcUtility class is a container for static helper functions. More...

Enumerations
enum class	LibSgfcPlusPlus::SgfcPropertyValueTypeDescriptorType {   DualValueType , ElistValueType , ListValueType , ComposedValueType ,   BasicValueType }
	SgfcPropertyValueTypeDescriptorType enumerates all types of ISgfcPropertyValueTypeDescriptor objects.
enum class	LibSgfcPlusPlus::SgfcBackendDataState { LibSgfcPlusPlus::SgfcBackendDataState::NotLoaded , LibSgfcPlusPlus::SgfcBackendDataState::PartiallyLoaded , LibSgfcPlusPlus::SgfcBackendDataState::FullyLoaded }
	SgfcBackendDataState enumerates the states that the SGFInfo data structure encapsulated by SgfcBackendDataWrapper can have. More...
enum class	LibSgfcPlusPlus::SgfcDataLocation { LibSgfcPlusPlus::SgfcDataLocation::Filesystem , LibSgfcPlusPlus::SgfcDataLocation::InMemoryBuffer }
	SgfcDataLocation enumerates the locations where SGF data can be read from or written to. More...

Detailed Description

The Internals module contains types that are internals, or private implementation details of the library.

All types that do not belong to the Public API module are in the Internals module.

Enumeration Type Documentation

SgfcBackendDataState

enum class LibSgfcPlusPlus::SgfcBackendDataState

strong

SgfcBackendDataState enumerates the states that the SGFInfo data structure encapsulated by SgfcBackendDataWrapper can have.

Enumerator
NotLoaded	The SGFInfo data structure is allocated and empty. It contains neither a raw file buffer with SGF content, nor any child data structures.
PartiallyLoaded	The SGFInfo data structure is allocated and contains a raw file buffer with SGF content, but no child data structures. The SGF content in the file buffer was either loaded from an actual file in the file system, generated from the content of an ISgfcDocument, or passed to the library by the library client.
FullyLoaded	The SGFInfo data structure is allocated and contains a raw file buffer with SGF content plus a full set of child data structures generated by parsing the SGF content.

SgfcDataLocation

enum class LibSgfcPlusPlus::SgfcDataLocation

strong

SgfcDataLocation enumerates the locations where SGF data can be read from or written to.

Enumerator
Filesystem	The SGF data is read from or written to a file in the filesystem.
InMemoryBuffer	The SGF data is read from or written to an in-memory buffer, typically an std::string.