C# Class Kimono.KMacroExpanderBase

Inheritance: Object, IDisposable
ファイルを表示 Open project: 0xd34df00d/Qross

Protected Properties

Property Type Description
interceptor Qyoto.SmokeInvocation

Public Methods

Method Description
Dispose ( ) : void
EscapeChar ( ) : QChar Obtain the macro escape character.
ExpandMacros ( StringBuilder str ) : void Perform safe macro expansion (substitution) on a string. name="str" the string in which macros are expanded in-place
ExpandMacrosShellQuote ( StringBuilder str ) : bool Same as above, but always starts at position 0, and unmatched closing parens and braces are treated as errors.
ExpandMacrosShellQuote ( StringBuilder str, int &pos ) : bool Perform safe macro expansion (substitution) on a string for use in shell commands.

NIX notes

Explicitly supported shell constructs: \ '' "" $'' $"" {} () $(()) ${} $() `` Implicitly supported shell constructs: (()) Unsupported shell constructs that will cause problems: Shortened "case $v in pat)" syntax. Use "case $v in (pat)" instead. The rest of the shell (incl. bash) syntax is simply ignored, as it is not expected to cause problems. Note that bash contains a bug which makes macro expansion within double quoted substitutions ("${VAR:-%macro}") inherently insecure. For security reasons, never put expandos in command line arguments that are shell commands by themselves - "sh -c 'foo \%f'" is taboo. "file=\%f sh -c 'foo "$file"'" is OK.

Windows notes

All quoting syntax supported by KShell is supported here as well. Additionally, command grouping via parentheses is recognized - note however, that the parser is much stricter about unquoted parentheses than cmd itself. The rest of the cmd syntax is simply ignored, as it is not expected to cause problems - do not use commands that embed other commands, though - "for /f ..." is taboo. name="str" the string in which macros are expanded in-place name="pos" the position inside the string at which parsing/substitution should start, and upon exit where processing stopped
KMacroExpanderBase ( ) : System
KMacroExpanderBase ( QChar c ) : System Constructor. name="c" escape char indicating start of macros, or QChar.Null for none
SetEscapeChar ( QChar c ) : void Set the macro escape character. name="c" escape char indicating start of macros, or QChar.Null if none

Protected Methods

Method Description
CreateProxy ( ) : void
KMacroExpanderBase ( Type dummy ) : System

Private Methods

Method Description
ExpandEscapedMacro ( string str, int pos, List ret ) : int
ExpandPlainMacro ( string str, int pos, List ret ) : int

Method Details

CreateProxy() protected method

protected CreateProxy ( ) : void
return void

Dispose() public method

public Dispose ( ) : void
return void

EscapeChar() public method

Obtain the macro escape character.
public EscapeChar ( ) : QChar
return Qyoto.QChar

ExpandMacros() public method

Perform safe macro expansion (substitution) on a string. name="str" the string in which macros are expanded in-place
public ExpandMacros ( StringBuilder str ) : void
str StringBuilder
return void

ExpandMacrosShellQuote() public method

Same as above, but always starts at position 0, and unmatched closing parens and braces are treated as errors.
public ExpandMacrosShellQuote ( StringBuilder str ) : bool
str StringBuilder
return bool

ExpandMacrosShellQuote() public method

Perform safe macro expansion (substitution) on a string for use in shell commands.

NIX notes

Explicitly supported shell constructs: \ '' "" $'' $"" {} () $(()) ${} $() `` Implicitly supported shell constructs: (()) Unsupported shell constructs that will cause problems: Shortened "case $v in pat)" syntax. Use "case $v in (pat)" instead. The rest of the shell (incl. bash) syntax is simply ignored, as it is not expected to cause problems. Note that bash contains a bug which makes macro expansion within double quoted substitutions ("${VAR:-%macro}") inherently insecure. For security reasons, never put expandos in command line arguments that are shell commands by themselves - "sh -c 'foo \%f'" is taboo. "file=\%f sh -c 'foo "$file"'" is OK.

Windows notes

All quoting syntax supported by KShell is supported here as well. Additionally, command grouping via parentheses is recognized - note however, that the parser is much stricter about unquoted parentheses than cmd itself. The rest of the cmd syntax is simply ignored, as it is not expected to cause problems - do not use commands that embed other commands, though - "for /f ..." is taboo. name="str" the string in which macros are expanded in-place name="pos" the position inside the string at which parsing/substitution should start, and upon exit where processing stopped
public ExpandMacrosShellQuote ( StringBuilder str, int &pos ) : bool
str StringBuilder
pos int
return bool

KMacroExpanderBase() public method

public KMacroExpanderBase ( ) : System
return System

KMacroExpanderBase() public method

Constructor. name="c" escape char indicating start of macros, or QChar.Null for none
public KMacroExpanderBase ( QChar c ) : System
c Qyoto.QChar
return System

KMacroExpanderBase() protected method

protected KMacroExpanderBase ( Type dummy ) : System
dummy System.Type
return System

SetEscapeChar() public method

Set the macro escape character. name="c" escape char indicating start of macros, or QChar.Null if none
public SetEscapeChar ( QChar c ) : void
c Qyoto.QChar
return void

Property Details

interceptor protected_oe property

protected SmokeInvocation,Qyoto interceptor
return Qyoto.SmokeInvocation