+
+
+**`a[href=index.html]{Home}`** expands to:
+
+ Home
+
+**`ul > li*3`** expands to:
+
+ Welcome to our site
+-
+
+
+
+
-
+
+
+
+
-
+
- +
- +
- +
| + | + | + | + |
| + | + | + | + |
+
+
+
+
+*/
diff --git a/plugins/generic/readme.txt b/plugins/generic/readme.txt
new file mode 100644
index 0000000..013f1ff
--- /dev/null
+++ b/plugins/generic/readme.txt
@@ -0,0 +1,2 @@
+This is provided for other users (unsupported editors, manual use, whatever).
+Simply put this in your path somewhere.
diff --git a/TextMate/Sparkup.tmbundle/Commands/Sparkup expand.tmCommand b/plugins/textmate/Sparkup.tmbundle/Commands/Sparkup expand.tmCommand
similarity index 100%
rename from TextMate/Sparkup.tmbundle/Commands/Sparkup expand.tmCommand
rename to plugins/textmate/Sparkup.tmbundle/Commands/Sparkup expand.tmCommand
diff --git a/TextMate/Sparkup.tmbundle/info.plist b/plugins/textmate/Sparkup.tmbundle/info.plist
similarity index 100%
rename from TextMate/Sparkup.tmbundle/info.plist
rename to plugins/textmate/Sparkup.tmbundle/info.plist
diff --git a/plugins/textmate/readme.txt b/plugins/textmate/readme.txt
new file mode 100644
index 0000000..e81ea6a
--- /dev/null
+++ b/plugins/textmate/readme.txt
@@ -0,0 +1,6 @@
+Instructions:
+
+ Simply double-click on the Sparkup.tmbundle package in Finder. This will install Sparkup
+ automatically. In TextMate, open an HTML file (or set the document type to HTML) type in
+ something (e.g., #header > h1), then press Ctrl + E. Pressing Tab will cycle through empty
+ elements.
diff --git a/vim/ftplugin/html/sparkup.vim b/plugins/vim/ftplugin/html/sparkup.vim
similarity index 100%
rename from vim/ftplugin/html/sparkup.vim
rename to plugins/vim/ftplugin/html/sparkup.vim
diff --git a/plugins/vim/install.sh b/plugins/vim/install.sh
new file mode 100755
index 0000000..7670594
--- /dev/null
+++ b/plugins/vim/install.sh
@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+mkdir -p ~/.vim/ftplugin/html
+cp -R ftplugin/html/* ~/.vim/ftplugin/html
+chmod +x ~/.vim/ftplugin/html/sparkup.py
diff --git a/vim/README.txt b/plugins/vim/readme.txt
similarity index 87%
rename from vim/README.txt
rename to plugins/vim/readme.txt
index b74460f..b931e34 100644
--- a/vim/README.txt
+++ b/plugins/vim/readme.txt
@@ -4,7 +4,8 @@ Installation
Copy the contents of vim/ftplugin/ to your ~/.vim/ftplugin directory.
(Assuming your current dir is sparkup/vim/)
- $ cp -R ftplugin ~/.vim/
+ $ mkdir -p ~/.vim/ftplugin/html
+ $ cp -R ftplugin/html/* ~/.vim/ftplugin/html/
Configuration
-------------
diff --git a/sourcescribe.conf b/sourcescribe.conf
new file mode 100644
index 0000000..07e09d6
--- /dev/null
+++ b/sourcescribe.conf
@@ -0,0 +1,53 @@
+# -----------------------------------------------------------------------------
+# SourceScribe configuration
+# -----------------------------------------------------------------------------
+# This project is documented using SourceScribe. This file describes the
+# configuration for documentation generation.
+# -----------------------------------------------------------------------------
+
+# Document title
+# Enter your main title here. You can define your own home page by making
+# a page with this name.
+#
+name: Sparkup manual
+
+# Document outputs
+# Define as many outputs here as you need. Available drivers by
+# default are 'html', which you can use as many times as you want.
+#
+# You must always define "driver" (which defines which output plugin to
+# use) and "path" (the directory where the output documents will be put in,
+# relative to where this config file is)
+#
+output:
+
+ - driver: "html"
+ path: "docs"
+ template: "default"
+
+# Source paths (Optional)
+# Defines where the sources are. Relative paths are resolved from where
+# this config file lies in. This can be in defined as an array for multiple
+# paths.
+#
+# Example: src_path: [src, www]
+#
+# In the example above, if this configuration file is in
+# ~/myproject/sourcescribe.conf, this src_path line will direct
+# SourceScribe to check on both ~/myproject/src and ~/myproject/www.
+#
+src_path:
+ - "docsrc"
+
+# Exclusions (Optional)
+# These are files to be excluded in regex format.
+# This list is completely optional and may be omitted.
+#
+exclude:
+ - \.git/
+ - \.svn/
+ - \.html$
+ - /cache/
+ - \.swp$
+ - \.swo$
+ - ~$
diff --git a/sparkup b/sparkup
deleted file mode 100755
index 50de2a8..0000000
--- a/sparkup
+++ /dev/null
@@ -1,1087 +0,0 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
-version = "0.1.3"
-
-import os
-import fileinput
-import getopt
-import sys
-import re
-
-# ===============================================================================
-
-class Dialect:
- shortcuts = {}
- synonyms = {}
- required = {}
- short_tags = ()
-
-class HtmlDialect(Dialect):
- shortcuts = {
- 'cc:ie': {
- 'opening_tag': ''},
- 'cc:ie6': {
- 'opening_tag': ''},
- 'cc:ie7': {
- 'opening_tag': ''},
- 'cc:noie': {
- 'opening_tag': '',
- 'closing_tag': ''},
- 'html:4t': {
- 'expand': True,
- 'opening_tag':
- '\n' +
- '\n' +
- '\n' +
- ' ' + '\n' +
- ' ' + '-
+
+
Footer
+ul>li
`, the `prefix` is ``.
- prefix = ''
-
- # Property: suffix
- # (string) The trailing tag at the end.
- suffix = ''
- pass
-
-# ===============================================================================
-
-class Element:
- """An element.
- """
-
- def __init__(self, token=None, parent=None, count=None, local_count=None, \
- parser=None, opening_tag=None, closing_tag=None, \
- attributes=None, name=None, text=None):
- """Constructor.
-
- This is called by ???.
-
- Description:
- All parameters are optional.
-
- token - (Token) The token (required)
- parent - (Element) Parent element; `None` if root
- count - (Int) The number to substitute for `&` (e.g., in `li.item-$`)
- local_count - (Int) The number to substitute for `$` (e.g., in `li.item-&`)
- parser - (Parser) The parser
-
- attributes - ...
- name - ...
- text - ...
- """
-
- self.children = []
- self.attributes = {}
- self.parser = parser
-
- if token is not None:
- # Assumption is that token is of type [[Token]] and is
- # a [[Token.ELEMENT]].
- self.name = token.name
- self.attributes = token.attributes.copy()
- self.text = token.text
- self.populate = token.populate
- self.expand = token.expand
- self.opening_tag = token.opening_tag
- self.closing_tag = token.closing_tag
-
- # `count` can be given. This will substitude & in classname and ID
- if count is not None:
- for key in self.attributes:
- attrib = self.attributes[key]
- attrib = attrib.replace('&', ("%i" % count))
- if local_count is not None:
- attrib = attrib.replace('$', ("%i" % local_count))
- self.attributes[key] = attrib
-
- # Copy over from parameters
- if attributes: self.attributes = attribues
- if name: self.name = name
- if text: self.text = text
-
- self._fill_attributes()
-
- self.parent = parent
- if parent is not None:
- self.depth = parent.depth + 1
-
- if self.populate: self._populate()
-
- def render(self):
- """Renders the element, along with it's subelements, into HTML code.
-
- [Grouped under "Rendering methods"]
- """
-
- output = ""
- try: spaces_count = int(self.parser.options.options['indent-spaces'])
- except: spaces_count = 4
- spaces = ' ' * spaces_count
- indent = self.depth * spaces
-
- prefix, suffix = ('', '')
- if self.prefix: prefix = self.prefix + "\n"
- if self.suffix: suffix = self.suffix
-
- # Make the guide from the ID (/#header), or the class if there's no ID (/.item)
- # This is for the start-guide, end-guide and post-tag-guides
- guide_str = ''
- if 'id' in self.attributes:
- guide_str += "#%s" % self.attributes['id']
- elif 'class' in self.attributes:
- guide_str += ".%s" % self.attributes['class'].replace(' ', '.')
-
- # Build the post-tag guide (e.g.,
),
- # the start guide, and the end guide.
- guide = ''
- start_guide = ''
- end_guide = ''
- if ((self.name == 'div') and \
- (('id' in self.attributes) or ('class' in self.attributes))):
-
- if (self.parser.options.has('post-tag-guides')):
- guide = "" % guide_str
-
- if (self.parser.options.has('start-guide-format')):
- format = self.parser.options.get('start-guide-format')
- try: start_guide = format % guide_str
- except: start_guide = (format + " " + guide_str).strip()
- start_guide = "%s\n" % (indent, start_guide)
-
- if (self.parser.options.has('end-guide-format')):
- format = self.parser.options.get('end-guide-format')
- try: end_guide = format % guide_str
- except: end_guide = (format + " " + guide_str).strip()
- end_guide = "\n%s" % (indent, end_guide)
-
- # Short, self-closing tags () - short_tags = self.parser.dialect.short_tags - - # When it should be expanded.. - # (That is,
\n...\n
or similar -- wherein something must go
- # inside the opening/closing tags)
- if len(self.children) > 0 \
- or self.expand \
- or prefix or suffix \
- or (self.parser.options.has('expand-divs') and self.name == 'div'):
-
- for child in self.children:
- output += child.render()
-
- # For expand divs: if there are no children (that is, `output`
- # is still blank despite above), fill it with a blank line.
- if (output == ''): output = indent + spaces + "\n"
-
- # If we're a root node and we have a prefix or suffix...
- # (Only the root node can have a prefix or suffix.)
- if prefix or suffix:
- output = "%s%s%s%s%s\n" % \
- (indent, prefix, output, suffix, guide)
-
- # Uh..
- elif self.name != '' or \
- self.opening_tag is not None or \
- self.closing_tag is not None:
- output = start_guide + \
- indent + self.get_opening_tag() + "\n" + \
- output + \
- indent + self.get_closing_tag() + \
- guide + end_guide + "\n"
-
-
- # Short, self-closing tags () - elif self.name in short_tags: - output = "%s<%s />\n" % (indent, self.get_default_tag()) - - # Tags with text, possibly - elif self.name != '' or \ - self.opening_tag is not None or \ - self.closing_tag is not None: - output = "%s%s%s%s%s%s%s%s" % \ - (start_guide, indent, self.get_opening_tag(), \ - self.text, \ - self.get_closing_tag(), \ - guide, end_guide, "\n") - - # Else, it's an empty-named element (like the root). Pass. - else: pass - - - return output - - def get_default_tag(self): - """Returns the opening tag (without brackets). - - Usage: - element.get_default_tag() - - [Grouped under "Rendering methods"] - """ - - output = '%s' % (self.name) - for key, value in self.attributes.iteritems(): - output += ' %s="%s"' % (key, value) - return output - - def get_opening_tag(self): - if self.opening_tag is None: - return "<%s>" % self.get_default_tag() - else: - return self.opening_tag - - def get_closing_tag(self): - if self.closing_tag is None: - return "" % self.name - else: - return self.closing_tag - - def append(self, object): - """Registers an element as a child of this element. - - Usage: - element.append(child) - - Description: - Adds a given element `child` to the children list of this element. It - will be rendered when [[render()]] is called on the element. - - See also: - - [[get_last_child()]] - - [Grouped under "Traversion methods"] - """ - - self.children.append(object) - - def get_last_child(self): - """Returns the last child element which was [[append()]]ed to this element. - - Usage: - element.get_last_child() - - Description: - This is the same as using `element.children[-1]`. - - [Grouped under "Traversion methods"] - """ - - return self.children[-1] - - def _populate(self): - """Expands with default items. - - This is called when the [[populate]] flag is turned on. - """ - - if self.name == 'ul': - elements = [Element(name='li', parent=self, parser=self.parser)] - - elif self.name == 'dl': - elements = [ - Element(name='dt', parent=self, parser=self.parser), - Element(name='dd', parent=self, parser=self.parser)] - - elif self.name == 'table': - tr = Element(name='tr', parent=self, parser=self.parser) - td = Element(name='td', parent=tr, parser=self.parser) - tr.children.append(td) - elements = [tr] - - else: - elements = [] - - for el in elements: - self.children.append(el) - - def _fill_attributes(self): - """Fills default attributes for certain elements. - - Description: - This is called by the constructor. - - [Protected, grouped under "Protected methods"] - """ - - # Make sure 's have a href,
) short_tags = self.parser.dialect.short_tags @@ -592,7 +589,7 @@ def render(self): if len(self.children) > 0 \ or self.expand \ or prefix or suffix \ - or (self.parser.options.has('expand-divs') and self.name == 'div'): + or (self.parser.options.expand_divs and self.name == 'div'): for child in self.children: output += child.render() @@ -616,10 +613,10 @@ def render(self): output + \ indent + self.get_closing_tag() + \ guide + end_guide + "\n" - + # Short, self-closing tags (
) - elif self.name in short_tags: + elif self.name in short_tags: output = "%s<%s />\n" % (indent, self.get_default_tag()) # Tags with text, possibly @@ -632,10 +629,6 @@ def render(self): self.get_closing_tag(), \ guide, end_guide, "\n") - # Else, it's an empty-named element (like the root). Pass. - else: pass - - return output def get_default_tag(self): @@ -683,7 +676,8 @@ def append(self, object): self.children.append(object) def get_last_child(self): - """Returns the last child element which was [[append()]]ed to this element. + """Returns the last child element which was [[append()]]ed + to this element. Usage: element.get_last_child() @@ -740,13 +734,13 @@ def _fill_attributes(self): if attrib not in self.attributes: self.attributes[attrib] = attribs[attrib] - # --------------------------------------------------------------------------- + # ------------------------------------------------------------------------- # Property: last_child # [Read-only] last_child = property(get_last_child) - # --------------------------------------------------------------------------- + # ------------------------------------------------------------------------- # Property: parent # (Element) The parent element. @@ -784,42 +778,42 @@ def _fill_attributes(self): prefix = None suffix = None -# =============================================================================== +# ============================================================================= class Token: - def __init__(self, str, parser=None): + def __init__(self, string, parser=None): """Token. Description: - str - The string to parse + string - The string to parse In the string `div > ul`, there are 3 tokens. (`div`, `>`, and `ul`) For `>`, it will be a `Token` with `type` set to `Token.CHILD` """ - self.str = str.strip() + self.string = string.strip() self.attributes = {} self.parser = parser # Set the type. - if self.str == '<': + if self.string == '<': self.type = Token.PARENT - elif self.str == '>': + elif self.string == '>': self.type = Token.CHILD - elif self.str == '+': + elif self.string == '+': self.type = Token.SIBLING else: self.type = Token.ELEMENT self._init_element() - + def _init_element(self): """Initializes. Only called if the token is an element token. [Private] """ # Get the tag name. Default to DIV if none given. - name = re.findall('^([\w\-:]*)', self.str)[0] + name = re.findall(r'^([\w\-:]*)', self.string)[0] name = name.lower().replace('-', ':') # Find synonyms through this thesaurus @@ -828,10 +822,6 @@ def _init_element(self): name = synonyms[name] if ':' in name: - try: spaces_count = int(self.parser.options.get('indent-spaces')) - except: spaces_count = 4 - indent = ' ' * spaces_count - shortcuts = self.parser.dialect.shortcuts if name in shortcuts.keys(): for key, value in shortcuts[name].iteritems(): @@ -846,9 +836,9 @@ def _init_element(self): # Look for attributes attribs = [] - for attrib in re.findall('\[([^\]]*)\]', self.str): + for attrib in re.findall(r'\[([^\]]*)\]', self.string): attribs.append(attrib) - self.str = self.str.replace("[" + attrib + "]", "") + self.string = self.string.replace("[" + attrib + "]", "") if len(attribs) > 0: for attrib in attribs: try: key, value = attrib.split('=', 1) @@ -857,14 +847,14 @@ def _init_element(self): # Try looking for text text = None - for text in re.findall('\{([^\}]*)\}', self.str): - self.str = self.str.replace("{" + text + "}", "") + for text in re.findall(r'\{([^\}]*)\}', self.string): + self.string = self.string.replace("{" + text + "}", "") if text is not None: self.text = text # Get the class names classes = [] - for classname in re.findall('\.([\$a-zA-Z0-9_\-\&]+)', self.str): + for classname in re.findall(r'\.([\$a-zA-Z0-9_\-\&]+)', self.string): classes.append(classname) if len(classes) > 0: try: self.attributes['class'] @@ -873,28 +863,27 @@ def _init_element(self): self.attributes['class'] = self.attributes['class'].strip() # Get the ID - id = None - for id in re.findall('#([\$a-zA-Z0-9_\-\&]+)', self.str): pass - if id is not None: - self.attributes['id'] = id + id_match = re.search(r'#([\$a-zA-Z0-9_\-\&]+)', self.string) + if id_match is not None: + self.attributes['id'] = id_match.group(1) # See if there's a multiplier (e.g., "li*3") - multiplier = None - for multiplier in re.findall('\*\s*([0-9]+)', self.str): pass - if multiplier is not None: - self.multiplier = int(multiplier) + multiplier_match = re.search(r'\*\s*([0-9]+)', self.string) + if multiplier_match is not None: + self.multiplier = int(multiplier_match.group(1)) # Populate flag (e.g., ul+) - flags = None - for flags in re.findall('[\+\!]+$', self.str): pass - if flags is not None: - if '+' in flags: self.populate = True - if '!' in flags: self.expand = True + flags_match = re.search(r'[\+\!]+$', self.string) + if flags_match is not None: + if '+' in flags_match.group(0): + self.populate = True + if '!' in flags_match.group(0): + self.expand = True def __str__(self): - return self.str + return self.string - str = '' + string = '' parser = None # For elements @@ -910,178 +899,52 @@ def __str__(self): # Type type = 0 - ELEMENT = 2 + ELEMENT = 2 CHILD = 4 PARENT = 8 SIBLING = 16 -# =============================================================================== +# ============================================================================= -class Router: - """The router. - """ +def parse_args(): + optparser = OptionParser(version=VERSION, + description="Expands input into HTML.", + epilog="Please refer to the manual for more information.") - # Constructor - # --------------------------------------------------------------------------- - def __init__(self): - pass + optparser.add_option('--no-guides', action="store_true", help='Deprecated') + optparser.add_option('--post-tag-guides', action="store_true", + help='Adds comments at the end of DIV tags') + optparser.add_option('--textmate', action="store_true", + help='Adds snippet info (textmate mode)') + optparser.add_option('--indent-spaces', help='Indent spaces') + optparser.add_option('--expand-divs', action="store_true", + help='Automatically expand divs') + optparser.add_option('--no-last-newline', action="store_false", + help='Skip the trailing newline') + optparser.add_option('--start-guide-format', help='To be documented') + optparser.add_option('--end-guide-format', help='To be documented') + optparser.add_option('--end-guide-newline', help='To be documented') - # Methods - # --------------------------------------------------------------------------- + optparser.set_defaults(post_tag_guides=False, textmate=False, + indent_spaces=4, expand_divs=False, last_newline=True, + start_guide_format="", end_guide_format="", end_guide_newline=True) - def start(self, options=None, str=None, ret=None): - if (options): - self.options = Options(router=self, options=options, argv=None) - else: - self.options = Options(router=self, argv=sys.argv[1:], options=None) + # Make sure they're the correct types + opt_args = optparser.parse_args() + opt_args[0].indent_spaces = int(opt_args[0].indent_spaces) + opt_args[0].end_guide_newline = bool(int(opt_args[0].end_guide_newline)) + return opt_args - if (self.options.has('help')): - return self.help() +def main(): + (options, _) = parse_args() - elif (self.options.has('version')): - return self.version() + lines = sys.stdin.read() - else: - return self.parse(str=str, ret=ret) - - def help(self): - print "Usage: %s [OPTIONS]" % sys.argv[0] - print "Expands input into HTML." - print "" - for short, long, info in self.options.cmdline_keys: - if "Deprecated" in info: continue - if not short == '': short = '-%s,' % short - if not long == '': long = '--%s' % long.replace("=", "=XXX") - - print "%6s %-25s %s" % (short, long, info) - print "" - print "\n".join(self.help_content) - - def version(self): - print "Uhm, yeah." - - def parse(self, str=None, ret=None): - self.parser = Parser(self.options) - - try: - # Read the files - # for line in fileinput.input(): lines.append(line.rstrip(os.linesep)) - if str is not None: - lines = str - else: - lines = [sys.stdin.read()] - lines = " ".join(lines) - - except KeyboardInterrupt: - pass - - except: - sys.stderr.write("Reading failed.\n") - return - - try: - self.parser.load_string(lines) - output = self.parser.render() - if ret: return output - sys.stdout.write(output) - - except: - sys.stderr.write("Parse error. Check your input.\n") - print sys.exc_info()[0] - print sys.exc_info()[1] - - def exit(self): - sys.exit() - - help_content = [ - "Please refer to the manual for more information.", - ] - -# =============================================================================== - -class Options: - def __init__(self, router, argv, options=None): - # Init self - self.router = router - - # `options` can be given as a dict of stuff to preload - if options: - for k, v in options.iteritems(): - self.options[k] = v - return - - # Prepare for getopt() - short_keys, long_keys = "", [] - for short, long, info in self.cmdline_keys: # 'v', 'version' - short_keys += short - long_keys.append(long) - - try: - getoptions, arguments = getopt.getopt(argv, short_keys, long_keys) - - except getopt.GetoptError: - err = sys.exc_info()[1] - sys.stderr.write("Options error: %s\n" % err) - sys.stderr.write("Try --help for a list of arguments.\n") - return router.exit() - - # Sort them out into options - options = {} - i = 0 - for option in getoptions: - key, value = option # '--version', '' - if (value == ''): value = True - - # If the key is long, write it - if key[0:2] == '--': - clean_key = key[2:] - options[clean_key] = value - - # If the key is short, look for the long version of it - elif key[0:1] == '-': - for short, long, info in self.cmdline_keys: - if short == key[1:]: - print long - options[long] = True - - # Done - for k, v in options.iteritems(): - self.options[k] = v - - def __getattr__(self, attr): - return self.get(attr) - - def get(self, attr): - try: return self.options[attr] - except: return None - - def has(self, attr): - try: return self.options.has_key(attr) - except: return False - - options = { - 'indent-spaces': 4 - } - cmdline_keys = [ - ('h', 'help', 'Shows help'), - ('v', 'version', 'Shows the version'), - ('', 'no-guides', 'Deprecated'), - ('', 'post-tag-guides', 'Adds comments at the end of DIV tags'), - ('', 'textmate', 'Adds snippet info (textmate mode)'), - ('', 'indent-spaces=', 'Indent spaces'), - ('', 'expand-divs', 'Automatically expand divs'), - ('', 'no-last-newline', 'Skip the trailing newline'), - ('', 'start-guide-format=', 'To be documented'), - ('', 'end-guide-format=', 'To be documented'), - ] - - # Property: router - # Router - router = 1 - -# =============================================================================== + parser = Parser(options, lines) + + output = parser.render() + sys.stdout.write(output) if __name__ == "__main__": - z = Router() - z.start() + main() diff --git a/sparkup-unittest.py b/src/tests/sparkup-unittest.py similarity index 94% rename from sparkup-unittest.py rename to src/tests/sparkup-unittest.py index a27b7f7..d3209b2 100755 --- a/sparkup-unittest.py +++ b/src/tests/sparkup-unittest.py @@ -1,6 +1,8 @@ #!/usr/bin/env python # -*- coding: utf-8 -*- import sys +import os +sys.path.append(os.path.join(os.path.curdir, '..', 'sparkup')) import sparkup class SparkupTest: @@ -105,18 +107,15 @@ def run(self): """Run Forrest run!""" print "Test results:" - for name, case in self.cases.iteritems(): - try: options_key = case['options'] - except: options_key = 'default' - - try: options = self.options[options_key] - except: options = self.options['default'] + (options, _) = sparkup.parse_args() + options.textmate = True + options.post_tag_guides = True + options.last_newline = False + for name, case in self.cases.iteritems(): # Output buffer - r = sparkup.Router() input = case['input'] - output = r.start(options=options, str=input, ret=True) - del r + output = sparkup.Parser(options, input).render() # Did it work? result = output == case['output'] diff --git a/vim/ftplugin/html/sparkup.py b/vim/ftplugin/html/sparkup.py deleted file mode 100755 index 50de2a8..0000000 --- a/vim/ftplugin/html/sparkup.py +++ /dev/null @@ -1,1087 +0,0 @@ -#!/usr/bin/env python -# -*- coding: utf-8 -*- -version = "0.1.3" - -import os -import fileinput -import getopt -import sys -import re - -# =============================================================================== - -class Dialect: - shortcuts = {} - synonyms = {} - required = {} - short_tags = () - -class HtmlDialect(Dialect): - shortcuts = { - 'cc:ie': { - 'opening_tag': ''}, - 'cc:ie6': { - 'opening_tag': ''}, - 'cc:ie7': { - 'opening_tag': ''}, - 'cc:noie': { - 'opening_tag': '', - 'closing_tag': ''}, - 'html:4t': { - 'expand': True, - 'opening_tag': - '\n' + - '\n' + - '\n' + - ' ' + '\n' + - ' ' + '
ul>li
`, the `prefix` is ``.
- prefix = ''
-
- # Property: suffix
- # (string) The trailing tag at the end.
- suffix = ''
- pass
-
-# ===============================================================================
-
-class Element:
- """An element.
- """
-
- def __init__(self, token=None, parent=None, count=None, local_count=None, \
- parser=None, opening_tag=None, closing_tag=None, \
- attributes=None, name=None, text=None):
- """Constructor.
-
- This is called by ???.
-
- Description:
- All parameters are optional.
-
- token - (Token) The token (required)
- parent - (Element) Parent element; `None` if root
- count - (Int) The number to substitute for `&` (e.g., in `li.item-$`)
- local_count - (Int) The number to substitute for `$` (e.g., in `li.item-&`)
- parser - (Parser) The parser
-
- attributes - ...
- name - ...
- text - ...
- """
-
- self.children = []
- self.attributes = {}
- self.parser = parser
-
- if token is not None:
- # Assumption is that token is of type [[Token]] and is
- # a [[Token.ELEMENT]].
- self.name = token.name
- self.attributes = token.attributes.copy()
- self.text = token.text
- self.populate = token.populate
- self.expand = token.expand
- self.opening_tag = token.opening_tag
- self.closing_tag = token.closing_tag
-
- # `count` can be given. This will substitude & in classname and ID
- if count is not None:
- for key in self.attributes:
- attrib = self.attributes[key]
- attrib = attrib.replace('&', ("%i" % count))
- if local_count is not None:
- attrib = attrib.replace('$', ("%i" % local_count))
- self.attributes[key] = attrib
-
- # Copy over from parameters
- if attributes: self.attributes = attribues
- if name: self.name = name
- if text: self.text = text
-
- self._fill_attributes()
-
- self.parent = parent
- if parent is not None:
- self.depth = parent.depth + 1
-
- if self.populate: self._populate()
-
- def render(self):
- """Renders the element, along with it's subelements, into HTML code.
-
- [Grouped under "Rendering methods"]
- """
-
- output = ""
- try: spaces_count = int(self.parser.options.options['indent-spaces'])
- except: spaces_count = 4
- spaces = ' ' * spaces_count
- indent = self.depth * spaces
-
- prefix, suffix = ('', '')
- if self.prefix: prefix = self.prefix + "\n"
- if self.suffix: suffix = self.suffix
-
- # Make the guide from the ID (/#header), or the class if there's no ID (/.item)
- # This is for the start-guide, end-guide and post-tag-guides
- guide_str = ''
- if 'id' in self.attributes:
- guide_str += "#%s" % self.attributes['id']
- elif 'class' in self.attributes:
- guide_str += ".%s" % self.attributes['class'].replace(' ', '.')
-
- # Build the post-tag guide (e.g.,
),
- # the start guide, and the end guide.
- guide = ''
- start_guide = ''
- end_guide = ''
- if ((self.name == 'div') and \
- (('id' in self.attributes) or ('class' in self.attributes))):
-
- if (self.parser.options.has('post-tag-guides')):
- guide = "" % guide_str
-
- if (self.parser.options.has('start-guide-format')):
- format = self.parser.options.get('start-guide-format')
- try: start_guide = format % guide_str
- except: start_guide = (format + " " + guide_str).strip()
- start_guide = "%s\n" % (indent, start_guide)
-
- if (self.parser.options.has('end-guide-format')):
- format = self.parser.options.get('end-guide-format')
- try: end_guide = format % guide_str
- except: end_guide = (format + " " + guide_str).strip()
- end_guide = "\n%s" % (indent, end_guide)
-
- # Short, self-closing tags () - short_tags = self.parser.dialect.short_tags - - # When it should be expanded.. - # (That is,
\n...\n
or similar -- wherein something must go
- # inside the opening/closing tags)
- if len(self.children) > 0 \
- or self.expand \
- or prefix or suffix \
- or (self.parser.options.has('expand-divs') and self.name == 'div'):
-
- for child in self.children:
- output += child.render()
-
- # For expand divs: if there are no children (that is, `output`
- # is still blank despite above), fill it with a blank line.
- if (output == ''): output = indent + spaces + "\n"
-
- # If we're a root node and we have a prefix or suffix...
- # (Only the root node can have a prefix or suffix.)
- if prefix or suffix:
- output = "%s%s%s%s%s\n" % \
- (indent, prefix, output, suffix, guide)
-
- # Uh..
- elif self.name != '' or \
- self.opening_tag is not None or \
- self.closing_tag is not None:
- output = start_guide + \
- indent + self.get_opening_tag() + "\n" + \
- output + \
- indent + self.get_closing_tag() + \
- guide + end_guide + "\n"
-
-
- # Short, self-closing tags () - elif self.name in short_tags: - output = "%s<%s />\n" % (indent, self.get_default_tag()) - - # Tags with text, possibly - elif self.name != '' or \ - self.opening_tag is not None or \ - self.closing_tag is not None: - output = "%s%s%s%s%s%s%s%s" % \ - (start_guide, indent, self.get_opening_tag(), \ - self.text, \ - self.get_closing_tag(), \ - guide, end_guide, "\n") - - # Else, it's an empty-named element (like the root). Pass. - else: pass - - - return output - - def get_default_tag(self): - """Returns the opening tag (without brackets). - - Usage: - element.get_default_tag() - - [Grouped under "Rendering methods"] - """ - - output = '%s' % (self.name) - for key, value in self.attributes.iteritems(): - output += ' %s="%s"' % (key, value) - return output - - def get_opening_tag(self): - if self.opening_tag is None: - return "<%s>" % self.get_default_tag() - else: - return self.opening_tag - - def get_closing_tag(self): - if self.closing_tag is None: - return "" % self.name - else: - return self.closing_tag - - def append(self, object): - """Registers an element as a child of this element. - - Usage: - element.append(child) - - Description: - Adds a given element `child` to the children list of this element. It - will be rendered when [[render()]] is called on the element. - - See also: - - [[get_last_child()]] - - [Grouped under "Traversion methods"] - """ - - self.children.append(object) - - def get_last_child(self): - """Returns the last child element which was [[append()]]ed to this element. - - Usage: - element.get_last_child() - - Description: - This is the same as using `element.children[-1]`. - - [Grouped under "Traversion methods"] - """ - - return self.children[-1] - - def _populate(self): - """Expands with default items. - - This is called when the [[populate]] flag is turned on. - """ - - if self.name == 'ul': - elements = [Element(name='li', parent=self, parser=self.parser)] - - elif self.name == 'dl': - elements = [ - Element(name='dt', parent=self, parser=self.parser), - Element(name='dd', parent=self, parser=self.parser)] - - elif self.name == 'table': - tr = Element(name='tr', parent=self, parser=self.parser) - td = Element(name='td', parent=tr, parser=self.parser) - tr.children.append(td) - elements = [tr] - - else: - elements = [] - - for el in elements: - self.children.append(el) - - def _fill_attributes(self): - """Fills default attributes for certain elements. - - Description: - This is called by the constructor. - - [Protected, grouped under "Protected methods"] - """ - - # Make sure 's have a href,