yagdoc.inspector

Package yagdoc :: Module inspector

[show private | hide private]

Module yagdoc.inspector

Constructing GObject C inspector and parsing its output.

Classes
`Binding`	Representation of the inspected information about one keyboard binding.
`InspectConstructor`	Customize and write `inspect` program C code.
`Inspector`	Parse `inspect` GObject inspection output.
`Property`	Representation of the inspected information about one GObject property.
`Signal`	Representation of the inspected information about one GSignal.
`Type`	Representation of the inspected information about one GType.

Exceptions
`InspectorError`	Base class for inspector exceptions
`InvalidFlagsError`	Flag list has not the form <allowed-flags-characters>
`InvalidHookNameError`	Hook name is invalid
`InvalidStringError`	Malformed quoted string
`JunkError`	Malformed line
`UnknownSectionError`	Section is not known

Function Summary
`int`	`demangle_flags(flags, flag_values)` Remove brackets from a flag list and check permitted characters.
couple of strings or `None`s	`parse_string(text, unescape, fail)` Parse a quoted string.

Function Details

Remove brackets from a flag list and check permitted characters.

Parameters:: flags - Flag list of the form <abcd>.
(type=str); flag_values - Dictionary mapping characters allowed in flags to their integer values.
(type=dict)

Parse a quoted string.

Parameters:: text - Quoted string to parse.
(type=str); unescape - If True, the surrounding quotes are removed and C character escapes unescaped.
(type=bool); fail - If True, InvalidStringError exception is raised when text is not string. Note if text looks like a string but is not well-formed, InvalidStringError exception is raised regardless this flag.
(type=bool)

Returns:: Couple (string, remainder) on success; (None, None) on failure (if not fatal).
(type=couple of strings or Nones)

Generated by Epydoc 2.1 on Fri Oct 5 00:36:53 2007