Package SCons :: Module Subst :: Class CmdStringHolder
[show private | hide private]
[frames | no frames]

Class CmdStringHolder

UserString --+
             |
            CmdStringHolder


This is a special class used to hold strings generated by scons_subst() and scons_subst_list(). It defines a special method escape(). When passed a function with an escape algorithm for a particular platform, it will return the contained string with the proper escape sequences inserted.


Method Summary
  __init__(self, cmd, literal)
  escape(self, escape_func, quote_func)
Escape the string with the supplied function.
  is_literal(self)
    Inherited from UserString
  __add__(self, other)
  __cmp__(self, string)
  __complex__(self)
  __contains__(self, char)
  __float__(self)
  __getitem__(self, index)
  __getslice__(self, start, end)
  __hash__(self)
  __int__(self)
  __len__(self)
  __long__(self)
  __mod__(self, args)
  __mul__(self, n)
  __radd__(self, other)
  __repr__(self)
  __rmul__(self, n)
  __str__(self)
  capitalize(self)
  center(self, width, *args)
  count(self, sub, start, end)
  decode(self, encoding, errors)
  encode(self, encoding, errors)
  endswith(self, suffix, start, end)
  expandtabs(self, tabsize)
  find(self, sub, start, end)
  index(self, sub, start, end)
  isalnum(self)
  isalpha(self)
  isdecimal(self)
  isdigit(self)
  islower(self)
  isnumeric(self)
  isspace(self)
  istitle(self)
  isupper(self)
  join(self, seq)
  ljust(self, width, *args)
  lower(self)
  lstrip(self, chars)
  partition(self, sep)
  replace(self, old, new, maxsplit)
  rfind(self, sub, start, end)
  rindex(self, sub, start, end)
  rjust(self, width, *args)
  rpartition(self, sep)
  rsplit(self, sep, maxsplit)
  rstrip(self, chars)
  split(self, sep, maxsplit)
  splitlines(self, keepends)
  startswith(self, prefix, start, end)
  strip(self, chars)
  swapcase(self)
  title(self)
  translate(self, *args)
  upper(self)
  zfill(self, width)

Method Details

escape(self, escape_func, quote_func=<function quote_spaces at 0xd5e2a8>)

Escape the string with the supplied function. The function is expected to take an arbitrary string, then return it with all special characters escaped and ready for passing to the command interpreter.

After calling this function, the next call to str() will return the escaped string.


Generated by Epydoc 2.1 on Wed Dec 12 09:39:32 2007 http://epydoc.sf.net