Namespaces | |
maxon::ReadArchiveClasses | |
maxon::WriteArchiveClasses | |
maxon::URLFLAGS | |
maxon::STREAMFLAGS | |
maxon::StringEncodings | |
maxon::StringDecodings | |
maxon::StreamConversions | |
Classes | |
class | ReadArchiveInterface |
class | WriteArchiveInterface |
class | IoBrowseInterface |
class | ResolveInterface |
class | IoConnectionInterface |
class | IoHandlerInterface |
class | IoMemoryInterface |
class | IoDualInOutputStreamInterface |
class | IoPipeInOutputStreamInterface |
class | UrlOrStream< STREAM > |
class | IoErrorInterface |
class | FileFormatErrorInterface |
class | UnknownFileSizeErrorInterface |
class | BaseStreamInterface |
class | InputStreamInterface |
class | OutputStreamInterface |
class | InOutputStreamInterface |
class | LexerInterface |
class | StringEncodingInterface |
class | StringDecodingInterface |
class | UrlInterface |
class | Url |
class | IoFileOutputHelper |
class | IoFileInputHelper |
class | IoXmlNodeInterface |
class | IoXmlParser |
class | SourceControlChangeEntry |
class | SourceControlInterface |
class | SmtpErrorInterface |
struct | SmtpReceiver |
class | SmtpMailInterface |
Macros | |
#define | REGISTER_STRINGENCODING(EXTENSION, CATEGORY, IDSYM, IMPLCLASS) |
#define | REGISTER_STRINGENCODING_TEMPLATE(EXTENSION, CATEGORY, IDSYM, IMPLCLASS) |
#define | MAXON_DECLARATION_STRINGENCODING(IDSTR, IDSYM) |
#define | MM_MediaText |
#define | MM_MediaImage |
#define | MM_MediaAudio |
#define | MM_MediaVideo |
#define | MM_MediaApplication |
#define | MM_MediaMultiPart |
#define | MM_MediaMessage |
#define | MM_SubHtml |
#define | MM_SubPlain |
#define | MM_SubRtf |
#define | MM_SubBinhex |
#define | MM_SubStuffit |
#define | MM_SubZip |
#define | MM_SubOctet |
#define | MM_SubPS |
#define | MM_SubPdf |
#define | MM_SubGif |
#define | MM_SubJpeg |
#define | MM_SubPng |
#define | MM_SubTiff |
#define | MM_SubMpeg |
#define | MM_SubMov |
#define | MM_SubAVI |
#define | MM_EncodingBase64 |
Typedefs | |
using | ExtractCallback = Delegate< Result< Bool >(const String &inputName, Url &outputName, IOATTRIBUTES &fileAttributes)> |
using | PIPEHANDLE = int |
using | UrlOrInputStream = UrlOrStream< InputStreamRef > |
using | UrlOrOutputStream = UrlOrStream< OutputStreamRef > |
using | UrlScheme = Id |
using | SCConversionFunction = Delegate< Result< Data >(const CString &val)> |
using | SCTypeConversion = HashMap< CString, SCConversionFunction > |
Functions | |
enum maxon::IOARCHIVESTOREMETHOD | MAXON_ENUM_LIST (IOARCHIVESTOREMETHOD) |
enum maxon::IOARCHIVEEXTRACTFLAGS | MAXON_ENUM_FLAGS (IOARCHIVEEXTRACTFLAGS) |
MAXON_REGISTRY (Class< ReadArchiveRef >, ReadArchiveClasses, "net.maxon.registry.readarchiveclasses") | |
MAXON_REGISTRY (Class< WriteArchiveRef >, WriteArchiveClasses, "net.maxon.registry.writearchiveclasses") | |
enum maxon::IOBROWSEFLAGS | MAXON_ENUM_FLAGS (IOBROWSEFLAGS, "net.maxon.datatype.enum.iobrowseflags") |
MAXON_DECLARATION (Class< IoBrowseRef >, IoBrowseBaseClass, "net.maxon.class.iobrowsebase") | |
MAXON_DECLARATION (Class< IoConnectionRef >, IoConnectionBaseClass, "net.maxon.class.ioconnectionbase") | |
MAXON_DECLARATION (Class< IoConnectionRef >, IoConnectionFileClass, "net.maxon.class.ioconnectionfile") | |
MAXON_REGISTRY (IoHandler, IoHandlers, "net.maxon.registry.iohandlers") | |
MAXON_DECLARATION (Class< IoHandler >, IoHandlerObjectBaseClass, "net.maxon.class.iohandlerobjectbase") | |
MAXON_DECLARATION (Class< IoHandler >, IoHandlerObjectFileClass, "net.maxon.class.iohandlerobjectfile") | |
MAXON_DECLARATION (Class< IoDualInOutputStreamRef >, InOutputStreamDualClass, "net.maxon.class.inoutputstreamdual") | |
MAXON_DECLARATION (Class< IoError >, IoErrorObjectClass, "net.maxon.class.ioerrorobject") | |
MAXON_DECLARATION (Class< InputStreamRef >, InputStreamBaseClass, "net.maxon.class.inputstreambase") | |
MAXON_DECLARATION (Class< OutputStreamRef >, OutputStreamBaseClass, "net.maxon.class.outputstreambase") | |
MAXON_DECLARATION (Class< InOutputStreamRef >, InOutputStreamBaseClass, "net.maxon.class.inoutputstreambase") | |
MAXON_DECLARATION (Class< InputStreamRef >, InputStreamDecoratorBaseClass, "net.maxon.class.inputstreamdecorator") | |
MAXON_DECLARATION (Class< OutputStreamRef >, OutputStreamDecoratorBaseClass, "net.maxon.class.outputstreamdecorator") | |
MAXON_DECLARATION (Class< InOutputStreamRef >, InOutputStreamDecoratorBaseClass, "net.maxon.class.inoutputstreamdecorator") | |
Result< Int > | Int64ToInt (Int64 value) |
enum maxon::LEXERSYMBOL UChar | MAXON_ENUM_LIST (LEXERSYMBOL) |
enum maxon::LEXERSYMBOLFLAGS | MAXON_ENUM_FLAGS (LEXERSYMBOLFLAGS) |
enum maxon::LEXERINITFLAGS | MAXON_ENUM_FLAGS (LEXERINITFLAGS) |
MAXON_REGISTRY (StringEncodingRef, StringEncodings, "net.maxon.registry.stringencodings") | |
MAXON_REGISTRY (StringDecodingRef, StringDecodings, "net.maxon.registry.stringdecodings") | |
enum maxon::GETBROWSEITERATORFLAGS | MAXON_ENUM_FLAGS (GETBROWSEITERATORFLAGS) |
MAXON_DATATYPE (SourceControlChangeEntry, "net.maxon.sourcecontrolchangeentry") | |
enum maxon::MEDIA | MAXON_ENUM_LIST (MEDIA) |
enum maxon::MEDIASUB | MAXON_ENUM_LIST (MEDIASUB) |
enum maxon::SMTPRECEIVERFIELD UChar | MAXON_ENUM_LIST (SMTPRECEIVERFIELD) |
MAXON_FUNCTION Result< Url > | operator+ (const String &s) const |
MAXON_FUNCTION Result< Url > | operator+ (const Url &s) const |
Variables | |
static const Id | URLSCHEME_HANDLER |
static const Id | URLSCHEME_FILESYSTEM |
static const Id | URLSCHEME_AUTHORITY |
static const Id | URLSCHEME_RELATIVE |
static const Id | URLSCHEME_VOLUME |
static const Id | URLSCHEME_NETWORK |
static const Id | URLSCHEME_STORAGE |
static const Id | URLSCHEME_ZIPFILE |
static const Id | URLSCHEME_GZIPFILE |
static const Id | URLSCHEME_MEMORY |
static const Id | URLSCHEME_TCP |
static const Id | URLSCHEME_WS |
static const Id | URLSCHEME_WSS |
static const Id | URLSCHEME_HTTP |
static const Id | URLSCHEME_HTTPS |
static const Id | URLSCHEME_FTP |
static const Id | URLSCHEME_SFTP |
static const Id | URLSCHEME_PERFORCE |
static const Id | URLSCHEME_CRYPTOFILE |
static const Id | URLSCHEME_CACHE |
static const Id | URLSCHEME_PIPE |
static const Id | URLSCHEME_STDOUT |
static const Id | URLSCHEME_STDERR |
static const Id | URLSCHEME_STDIN |
static const Id | URLSCHEME_APK_ASSET |
#define REGISTER_STRINGENCODING | ( | EXTENSION, | |
CATEGORY, | |||
IDSYM, | |||
IMPLCLASS | |||
) |
This Macro can be used to register an implementation of a stream en-/decoder.
[in] | EXTENSION | Registry to extend. (e.g. StringEncodings or StringDecodings). |
[in] | CATEGORY | Encoder or Decoder. |
[in] | IDSTR | Lowercase string with the id to be registered. e.g. "utf8". |
[in] | IDSYM | Mixed case id with the id to be registered. e.g. Utf8. |
[in] | IMPLCLASS | Implementation class name. |
#define REGISTER_STRINGENCODING_TEMPLATE | ( | EXTENSION, | |
CATEGORY, | |||
IDSYM, | |||
IMPLCLASS | |||
) |
This Macro can be used to register an implementation of a stream en-/decoder with a impl template class.
[in] | EXTENSION | Registry to extend. (e.g. StringEncodings or StringDecodings). |
[in] | CATEGORY | Encoder or Decoder. |
[in] | IDSTR | Lowercase string with the id to be registered. e.g. "utf8". |
[in] | IDSYM | Mixed case id with the id to be registered. e.g. Utf8. |
[in] | IMPLCLASS | Implementation class name. |
#define MAXON_DECLARATION_STRINGENCODING | ( | IDSTR, | |
IDSYM | |||
) |
This Macro adds a given string encoding to the 3 registries: StringEncodings, StringDecodings and StreamConversions.
[in] | IDSTR | Lowercase string with the id to be registered. e.g. "utf8". |
[in] | IDSYM | Mixed case id with the id to be registered. e.g. Utf8. |
#define MM_MediaText |
#define MM_MediaImage |
#define MM_MediaAudio |
#define MM_MediaVideo |
#define MM_MediaApplication |
#define MM_MediaMultiPart |
#define MM_MediaMessage |
#define MM_SubHtml |
#define MM_SubPlain |
#define MM_SubRtf |
#define MM_SubBinhex |
#define MM_SubStuffit |
#define MM_SubZip |
#define MM_SubOctet |
#define MM_SubPS |
#define MM_SubPdf |
#define MM_SubGif |
#define MM_SubJpeg |
#define MM_SubPng |
#define MM_SubTiff |
#define MM_SubMpeg |
#define MM_SubMov |
#define MM_SubAVI |
#define MM_EncodingBase64 |
using ExtractCallback = Delegate<Result<Bool>(const String& inputName, Url& outputName, IOATTRIBUTES& fileAttributes)> |
Callback used by ReadArchiveRef::Extract. This callback will be called before each file is extracted. inputName is the name that is stored within the archive. outputName is the (modifyable) path at which the file will be created. fileAttributes are the (modifyable) attributes that will be set. The return value determines whether the file will be extracted or not.
using PIPEHANDLE = int |
typedef UrlOrStream< InputStreamRef > UrlOrInputStream |
typedef UrlOrStream< OutputStreamRef > UrlOrOutputStream |
UrlScheme Id for Url handler. At the moment implemented are:
using SCConversionFunction = Delegate<Result<Data>(const CString& val)> |
using SCTypeConversion = HashMap<CString, SCConversionFunction> |
|
strong |
|
strong |
Extract Flags used in ReadArchiveInterface::Extract() and ReadArchiveInterface::ExtractSingleFile().
Enumerator | |
---|---|
NONE | No flags. |
OVERWRITE_EXISTING_FILE | Overwrites the file silently if it already exists in the directory. |
|
strong |
Possible flags of IoGetFlags()
|
strong |
Enumeration for special lexer symbols.
Enumerator | |
---|---|
NONE | |
ILLEGAL | |
ENDOFFILE | The end of file or stream was reached. |
IDENTIFIER | An arbitrary symbol that is neither a string, nor a value. It may contain unicode characters. |
STRING | A double-quoted string. |
STRINGCHR | A single-quoted string. |
NUMBER | A numerical value. |
NEWLINE | '\r', '\n' or a combination of both. |
CURLYBRACKET_OPEN | '{' symbol. |
CURLYBRACKET_CLOSE | '}' symbol. |
PARENTHESE_OPEN | '(' symbol. |
PARENTHESE_CLOSE | ')' symbol. |
SQUAREBRACKET_OPEN | '[' symbol. |
SQUAREBRACKET_CLOSE | ']' symbol. |
SLASH | '/' symbol. |
EQUAL | '=' symbol. |
COMMA | ',' symbol. |
SEMICOLON | ';' symbol. |
COLON | ':' symbol. |
PLUS | '+' symbol. |
TILDE | '~' symbol. |
PREPROCESSOR | '#' symbol. |
MULTIPLY | '*' symbol. |
PIPE | '|' symbol. |
AMPERSAND | '&' symbol. |
OPERATOR | One of the operator symbols added by LexerInterface::AddOperator. |
|
strong |
Flags used for LexerInterface::ReadNextSymbol() and LexerInterface::ReadNextSymbolExpected()
Enumerator | |
---|---|
NONE | |
NO_NUMBER | If set, numbers (and characters as '.' or '-') are not recognized as numbers. Instead either an LEXERSYMBOL::IDENTIFIER or LEXERSYMBOL::ILLEGAL will be generated (and GetIdent() returns the symbol). |
ALLOWSTRINGS | If set, strings starting with " or ' will be detected and LEXERSYMBOL::STRING is returned. GetIdent() returns the content of the string. |
MINUS_OPERATOR | If set, the minus symbol in front of a number will be reported as own token. |
|
strong |
Flags used in LexerInterface::Init()
|
strong |
|
strong |
attachment types for SmtpMailInterface
Enumerator | |
---|---|
UNKNOWN | unknown media |
TEXT | mediatype text |
IMAGE | mediatype image |
AUDIO | mediatype audio |
VIDEO | mediatype video |
APP | mediatype application |
MULTI | mediatype multipart |
|
strong |
subtype of media types for SmtpMailInterface
Enumerator | |
---|---|
UNKNOWN | |
HTML | |
HTML_PLAIN | |
GIF | |
JPEG | |
PNG | |
TIFF | |
MPEG | |
QUICKTIME | |
X_MSVIDEO | |
RTF | |
MAC_BINHEX40 | |
X_STUFFIT | |
ZIP | |
OCTET_STREAM | |
POSTSCRIPT | |
|
strong |
enum maxon::IOARCHIVESTOREMETHOD maxon::MAXON_ENUM_LIST | ( | IOARCHIVESTOREMETHOD | ) |
enum maxon::IOARCHIVEEXTRACTFLAGS maxon::MAXON_ENUM_FLAGS | ( | IOARCHIVEEXTRACTFLAGS | ) |
maxon::MAXON_REGISTRY | ( | Class< ReadArchiveRef > | , |
ReadArchiveClasses | , | ||
"net.maxon.registry.readarchiveclasses" | |||
) |
maxon::MAXON_REGISTRY | ( | Class< WriteArchiveRef > | , |
WriteArchiveClasses | , | ||
"net.maxon.registry.writearchiveclasses" | |||
) |
enum maxon::IOBROWSEFLAGS maxon::MAXON_ENUM_FLAGS | ( | IOBROWSEFLAGS | , |
"net.maxon.datatype.enum.iobrowseflags" | |||
) |
maxon::MAXON_DECLARATION | ( | Class< IoBrowseRef > | , |
IoBrowseBaseClass | , | ||
"net.maxon.class.iobrowsebase" | |||
) |
maxon::MAXON_DECLARATION | ( | Class< IoConnectionRef > | , |
IoConnectionBaseClass | , | ||
"net.maxon.class.ioconnectionbase" | |||
) |
maxon::MAXON_DECLARATION | ( | Class< IoConnectionRef > | , |
IoConnectionFileClass | , | ||
"net.maxon.class.ioconnectionfile" | |||
) |
maxon::MAXON_REGISTRY | ( | IoHandler | , |
IoHandlers | , | ||
"net.maxon.registry.iohandlers" | |||
) |
maxon::MAXON_DECLARATION | ( | Class< IoHandler > | , |
IoHandlerObjectBaseClass | , | ||
"net.maxon.class.iohandlerobjectbase" | |||
) |
maxon::MAXON_DECLARATION | ( | Class< IoHandler > | , |
IoHandlerObjectFileClass | , | ||
"net.maxon.class.iohandlerobjectfile" | |||
) |
maxon::MAXON_DECLARATION | ( | Class< IoDualInOutputStreamRef > | , |
InOutputStreamDualClass | , | ||
"net.maxon.class.inoutputstreamdual" | |||
) |
maxon::MAXON_DECLARATION | ( | Class< IoError > | , |
IoErrorObjectClass | , | ||
"net.maxon.class.ioerrorobject" | |||
) |
maxon::MAXON_DECLARATION | ( | Class< InputStreamRef > | , |
InputStreamBaseClass | , | ||
"net.maxon.class.inputstreambase" | |||
) |
maxon::MAXON_DECLARATION | ( | Class< OutputStreamRef > | , |
OutputStreamBaseClass | , | ||
"net.maxon.class.outputstreambase" | |||
) |
maxon::MAXON_DECLARATION | ( | Class< InOutputStreamRef > | , |
InOutputStreamBaseClass | , | ||
"net.maxon.class.inoutputstreambase" | |||
) |
maxon::MAXON_DECLARATION | ( | Class< InputStreamRef > | , |
InputStreamDecoratorBaseClass | , | ||
"net.maxon.class.inputstreamdecorator" | |||
) |
maxon::MAXON_DECLARATION | ( | Class< OutputStreamRef > | , |
OutputStreamDecoratorBaseClass | , | ||
"net.maxon.class.outputstreamdecorator" | |||
) |
maxon::MAXON_DECLARATION | ( | Class< InOutputStreamRef > | , |
InOutputStreamDecoratorBaseClass | , | ||
"net.maxon.class.inoutputstreamdecorator" | |||
) |
This function is often useful when getting a file length and need to check if the size is convertible into a memory size. depending on the platform 32 or 64 bit this might fail.
[in] | value | Value to cast to an Int. |
enum maxon::LEXERSYMBOL UChar maxon::MAXON_ENUM_LIST | ( | LEXERSYMBOL | ) |
enum maxon::LEXERSYMBOLFLAGS maxon::MAXON_ENUM_FLAGS | ( | LEXERSYMBOLFLAGS | ) |
enum maxon::LEXERINITFLAGS maxon::MAXON_ENUM_FLAGS | ( | LEXERINITFLAGS | ) |
maxon::MAXON_REGISTRY | ( | StringEncodingRef | , |
StringEncodings | , | ||
"net.maxon.registry.stringencodings" | |||
) |
maxon::MAXON_REGISTRY | ( | StringDecodingRef | , |
StringDecodings | , | ||
"net.maxon.registry.stringdecodings" | |||
) |
enum maxon::GETBROWSEITERATORFLAGS maxon::MAXON_ENUM_FLAGS | ( | GETBROWSEITERATORFLAGS | ) |
maxon::MAXON_DATATYPE | ( | SourceControlChangeEntry | , |
"net.maxon.sourcecontrolchangeentry" | |||
) |
enum maxon::MEDIA maxon::MAXON_ENUM_LIST | ( | MEDIA | ) |
enum maxon::MEDIASUB maxon::MAXON_ENUM_LIST | ( | MEDIASUB | ) |
enum maxon::SMTPRECEIVERFIELD UChar maxon::MAXON_ENUM_LIST | ( | SMTPRECEIVERFIELD | ) |
|
static |
The "handler" scheme returns all registered schemes when iterating over them.
|
static |
|
static |
Identifier for "volume" handler, you can use that to browse through all available volumes: for (const auto& it : Url(URLSCHEME_VOLUME).GetBrowseIterator(GETBROWSEITERATORFLAGS::NONE)) {}
|
static |
Identifier for "network" handler, you can use that to browse through all available network drives on the system: for (const auto& it : Url(URLSCHEME_NETWORK).GetBrowseIterator(GETBROWSEITERATORFLAGS::NONE)) {}
|
static |
Identifier for "storage" handler, you can use that to browse through all available storage devices on the system. These are devices that have no drive letter mounted (e.g. iPhone/iPad internal storage directory): for (const auto& it : Url(URLSCHEME_STORAGE).GetBrowseIterator(GETBROWSEITERATORFLAGS::NONE)) {}
|
static |
Identifier for "wss" ssl encrypted WebSocket file handler.
|
static |
Identifier for "perforce" source controls system handler
|
static |
Identifier for "crypto" file handler. It can encrypt/decrypt files on the fly while reading/writing data.
|
static |
Identifier for "cache" file handler. It can embed input streams into a cached file, e.g. for reading a zip file from ftp / http to speed up seeks and read operations.