Editra  0.7.08
Editra API Documentation
 All Classes Namespaces Functions Variables Properties
Classes | Functions | Variables
launch::handlers Namespace Reference

Classes

class  Meta
 Metadata namespace, acts as a container object for all FileTypeHandler meta attributes. More...
class  HandlerMeta
 Metaclass for manipulating a handler classes metadata converts all user defined 'meta' classes to a Meta class with all unset attributes initialized to the default setting. More...
class  FileTypeHandler
 Base default Output handler all output handlers should derive from this class. More...
class  AdaHandler
 FileTypeHandler for Ada. More...
class  BashHandler
 FileTypeHandler for Bash scripts. More...
class  BatchHandler
 FileTypeHandler for Dos batch files. More...
class  BooHandler
 FileTypeHandler for Boo. More...
class  CHandler
 FileTypeHandler for C Files. More...
class  CPPHandler
 FileTypeHandler for C++ Files. More...
class  CamlHandler
 FileTypeHandler for Caml. More...
class  CSHHandler
 FileTypeHandler for C-Shell. More...
class  DHandler
 FileTypeHandler for D. More...
class  FeriteHandler
 FileTypeHandler for Ferite. More...
class  HaskellHandler
 FileTypeHandler for Haskell. More...
class  HaxeHandler
 FileTypeHandler for haXe. More...
class  HTMLHandler
 FileTypeHandler for HTML. More...
class  InnoSetupHandler
 FileTypeHandler for Inno Setup Scripts. More...
class  KornHandler
 FileTypeHandler for Korn Shell scripts. More...
class  STATAHandler
 FileTypeHandler for Stata. More...
class  LatexHandler
 FileTypeHandler for LaTex. More...
class  LuaHandler
 FileTypeHandler for Lua. More...
class  NewLispHandler
 FileTypeHandler for newLisp. More...
class  NSISHandler
 FileTypeHandler for NSIS scripts. More...
class  PhpHandler
 FileTypeHandler for Php. More...
class  PikeHandler
 FileTypeHandler for Pike. More...
class  PerlHandler
 FileTypeHandler for Perl scripts. More...
class  PostScriptHandler
 FileTypeHandler for Post/GhostScript. More...
class  PythonHandler
 FileTypeHandler for Python. More...
class  RHandler
 FileTypeHandler for R. More...
class  RubyHandler
 FileTypeHandler for Ruby scripts. More...
class  TCLHandler
 FileTypeHandler for TCL/TK. More...
class  VBScriptHandler
 FileTypeHandler for VBScript. More...

Functions

def GetHandlerById
 Get a handler for the specified language id.
def GetHandlerByName
 Get an output handler by name.
def GetUserSettings
 Get the user settings for a given file type.
def InitCustomHandlers
 Init the custom handlers defined in the launch.xml file.
def LoadCustomHandler
 Load a custom Launch handler an xml string.
def XmlHandlerDelegate
 Create delegate class for creating new filetype handlers from a Launch Xml object.

Variables

string __author__ = "Cody Precord <cprecord@editra.org>"
 File Type Handlers The file type handlers are used to handle the execution of and output of the different file types that they represent.
string __svnid__ = "$Id: handlers.py 70431 2012-01-21 16:38:15Z CJP $"
string __revision__ = "$Revision: 70431 $"
list __all__ = ['GetHandlerById', 'GetHandlerByName', 'GetState', 'DEFAULT_HANDLER']
string DEFAULT_HANDLER = 'handler'
string CONFIG_KEY = 'Launch.Config2'
tuple RE_ANSI_START = re.compile(r'\[[34][0-9];01m')
tuple RE_ANSI_FORE = re.compile('\[3[0-9]m')
tuple RE_ANSI_BLOCK = re.compile('\[[34][0-9]m*.*?\[m')
tuple RE_ANSI_END = re.compile(r'\[[0]{0,1}m')
tuple RE_ANSI_ESC = re.compile('\[[0-9]+m')
dictionary ANSI
int STYLE_NORMAL = 0
int STYLE_INFO = 1
int STYLE_ERROR = 2
tuple RE_PROC_SE = re.compile('>{3,3}.*' + os.linesep)

Function Documentation

def launch.handlers.GetHandlerById (   lang_id)

Get a handler for the specified language id.

Get an output handler by name.

Get the user settings for a given file type.

Parameters:
namefile type name

Init the custom handlers defined in the launch.xml file.

Parameters:
pathpath to directory to find the launch xml in
Returns:
bool

Load a custom Launch handler an xml string.

Parameters:
xml_strLaunch Xml String
Returns:
bool

Create delegate class for creating new filetype handlers from a Launch Xml object.

Parameters:
xmlobjlaunchxml.Handler

Variable Documentation

string __author__ = "Cody Precord <cprecord@editra.org>"

File Type Handlers The file type handlers are used to handle the execution of and output of the different file types that they represent.

Each handler manages its own settings and configuration.

It is easy to extend the filetypes supported by the Launch plugin through this interface. To add support for a new filetype simply derive a new class from the base FileTypeHandler and override any of the following methods to provide custom functionality.

Required Overrides: __init__ : define default command mapping and default command __name__ : set the name of the handler, this should be the file type

Other Overrides: GetEnvironment : Return a dictionary of environmental variables to run the process within HandleHotSpot : Action to perform when a hotspot is clicked on in the output buffer. StyleText : Perform custom styling on the text as its added, line by line

string __revision__ = "$Revision: 70431 $"
string __svnid__ = "$Id: handlers.py 70431 2012-01-21 16:38:15Z CJP $"
dictionary ANSI
Initial value:
00001 {
00002         ## Foreground colours ##
00003         '' : (1, '#000000'),  # Black
00004         '' : (2, '#FF0000'),  # Red
00005         '' : (3, '#00FF00'),  # Green
00006         '' : (4, '#FFFF00'),  # Yellow
00007         '' : (5, '#0000FF'),  # Blue
00008         '' : (6, '#FF00FF'),  # Magenta
00009         '' : (7, '#00FFFF'),  # Cyan
00010         '' : (8, '#FFFFFF'),  # White
00011         #'' : default
00012 
00013         ## Background colour ##
00014         '' : (011, '#000000'),  # Black
00015         '' : (012, '#FF0000'),  # Red
00016         '' : (013, '#00FF00'),  # Green
00017         '' : (014, '#FFFF00'),  # Yellow
00018         '' : (015, '#0000FF'),  # Blue
00019         '' : (016, '#FF00FF'),  # Magenta
00020         '' : (017, '#00FFFF'),  # Cyan
00021         '' : (020, '#FFFFFF'),  # White
00022         #'' : default
00023         }
string CONFIG_KEY = 'Launch.Config2'
string DEFAULT_HANDLER = 'handler'
tuple RE_ANSI_BLOCK = re.compile('\[[34][0-9]m*.*?\[m')
tuple RE_ANSI_END = re.compile(r'\[[0]{0,1}m')
tuple RE_ANSI_ESC = re.compile('\[[0-9]+m')
tuple RE_ANSI_FORE = re.compile('\[3[0-9]m')
tuple RE_ANSI_START = re.compile(r'\[[34][0-9];01m')
tuple RE_PROC_SE = re.compile('>{3,3}.*' + os.linesep)
int STYLE_ERROR = 2
int STYLE_INFO = 1
int STYLE_NORMAL = 0
 All Classes Namespaces Functions Variables Properties