hsh :: command :: SingleQuotedToken :: Class SingleQuotedToken
[hide private]
[frames] | no frames]

Class SingleQuotedToken

object --+        
         |        
     Token --+    
             |    
     LeafToken --+
                 |
                SingleQuotedToken

Instance Methods [hide private]
 
terminates(self, ch)
Return a pair of strings if the first character of the provided text would terminate this token.
 
terminated(self)
Return True if this token will not accept any more characters at the end because it has terminated.
 
expand(self)
Return the expanded version of this token.

Inherited from LeafToken: __init__, __len__, __str__, dump, modify

Inherited from Token: commences, completions, expand_directives

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __sizeof__, __subclasshook__

Class Variables [hide private]
  commencer_ch = '\''

Inherited from Token: dquotable

Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

terminates(self, ch)

 

Return a pair of strings if the first character of the provided text would terminate this token. The first string are the characters to be included in the token, the second are the characters which spill over to the next token. Return None if the text would not terminate the token.

The token mustn't end in an escape character (\) because that would make the test incorrect.

The default implementation matches txt against the regexp self.terminator. On a match it returns match groups 1 and 2, otherwise it returns None. The default value of self.terminator is ()(\s) to terminate on whitespace, but not accept it.

Overrides: Token.terminates
(inherited documentation)

terminated(self)

 

Return True if this token will not accept any more characters at the end because it has terminated. The default implementation returns False.

Overrides: Token.terminated
(inherited documentation)

expand(self)

 

Return the expanded version of this token. Return value is a list of strings in which any special shell syntax is replaced with its expanded value, appropriate for passing as an arg in a process invocation.

Arg tokens will perform glob expansion on the results of this value, so other tokens should protect their response using escape_glob_chars() if appropriate.

The default implementation returns an array with one element containing the raw token.

Overrides: Token.expand
(inherited documentation)