# -*- coding: utf-8 -*-
#
# Tulip Python Bindings documentation build configuration file, created by
# sphinx-quickstart on Sat Apr  2 17:21:15 2011.
#
# This file is execfile()d with the current directory set to its containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.

import sys, os

# If extensions (or modules to document with autodoc) are in another directory,
# add these directories to sys.path here. If the directory is relative to the
# documentation root, use os.path.abspath to make it absolute, like shown here.

#sys.path.insert(0, os.path.abspath('.'))
# -- General configuration -----------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
#needs_sphinx = '1.0'

# Add any Sphinx extension module names here, as strings. They can be extensions
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
extensions = ['sphinx.ext.autodoc', 'sphinx.ext.coverage', 'sphinx.ext.pngmath']

# Add any paths that contain templates here, relative to this directory.
templates_path = ['../common/_templates']

# The suffix of source filenames.
source_suffix = '.rst'

# The encoding of source files.
#source_encoding = 'utf-8-sig'

# The master toctree document.
master_doc = 'index'

# General information about the project.
project = u'Tulip Python'
copyright = u'@CurrentYear@, Tulip Team'

# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = '@TulipMMVersion@'
# The full version, including alpha/beta/rc tags.
release = '@TulipVersion@'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
#language = None

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
#today = ''
# Else, today_fmt is used as the format for a strftime call.
#today_fmt = '%B %d, %Y'

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['html']

# The reST default role (used for this markup: `text`) to use for all documents.
#default_role = None

# If true, '()' will be appended to :func: etc. cross-reference text.
#add_function_parentheses = True

# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
#add_module_names = True

# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
#show_authors = False

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'

# A list of ignored prefixes for module index sorting.
#modindex_common_prefix = []


# -- Options for HTML output ---------------------------------------------------

# The theme to use for HTML and HTML Help pages.  See the documentation for
# a list of builtin themes.
html_theme = 'agogo'
html_style = 'customized.css'

# Theme options are theme-specific and customize the look and feel of a theme
# further.  For a list of options available for each theme, see the
# documentation.
#html_theme_options = {}

# Add any paths that contain custom themes here, relative to this directory.
#html_theme_path = []

# The name for this set of Sphinx documents.  If None, it defaults to
# "<project> v<release> documentation".
#html_title = None

# A shorter title for the navigation bar.  Default is the same as html_title.
#html_short_title = None

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
#html_logo = None

# The name of an image file (within the static path) to use as favicon of the
# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
html_favicon = '../../textures/logo32x32.ico'

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['../common/_static', '_static']

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
#html_last_updated_fmt = '%b %d, %Y'

# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
#html_use_smartypants = True

# Custom sidebar templates, maps document names to template names.
#html_sidebars = {}

# Additional templates that should be rendered to pages, maps page names to
# template names.
#html_additional_pages = {}

# If false, no module index is generated.
html_domain_indices = False

# If false, no index is generated.
#html_use_index = True

# If true, the index is split into individual pages for each letter.
html_split_index = False

# If true, links to the reST sources are added to the pages.
#html_show_sourcelink = True

# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
#html_show_sphinx = True

# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
#html_show_copyright = True

# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it.  The value of this option must be the
# base URL from which the finished HTML is served.
#html_use_opensearch = ''

# This is the file name suffix for HTML files (e.g. ".xhtml").
#html_file_suffix = None

# Output file base name for HTML help builder.
htmlhelp_basename = 'TulipPythonBindingsdoc'


# -- Options for LaTeX output --------------------------------------------------

# The paper size ('letter' or 'a4').
#latex_paper_size = 'letter'

# The font size ('10pt', '11pt' or '12pt').
#latex_font_size = '10pt'

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
  ('index', 'TulipPythonBindings.tex', u'Tulip Python Bindings Documentation',
   u'Tulip Team', 'manual'),
]

# The name of an image file (relative to this directory) to place at the top of
# the title page.
#latex_logo = None

# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
#latex_use_parts = False

# If true, show page references after internal links.
#latex_show_pagerefs = False

# If true, show URL addresses after external links.
#latex_show_urls = False

# Additional stuff for the LaTeX preamble.
#latex_preamble = ''

# Documents to append as an appendix to all manuals.
#latex_appendices = []

# If false, no module index is generated.
#latex_domain_indices = True


# -- Options for manual page output --------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
    ('index', 'tulippythonbindings', u'Tulip Python Documentation',
     [u'Tulip Team'], 1)
]

autoclass_content = "both"
methodDocstring = {}
methodSignature = {}

def process_docstring(app, what, name, obj, options, lines):
        if what == "class" or not obj.__doc__:
            return
        global methodSignature
        currentSignature = ""
        n = name.replace("tulipgui.", "")
        n = n.replace("tulipogl.", "")
        n = n.replace("tulip.", "")

        nbMethods = 0
        pos = 0
        signaturePos = {}
        while obj.__doc__.find(n, pos) != -1:
          pos = obj.__doc__.find(n, pos)
          signaturePos[nbMethods] = pos
          pos += len(n)
          nbMethods+=1


        if not n in methodDocstring.keys():
          methodDocstring[n] = [0] * nbMethods

        methodIdx = 0

        for i in range(nbMethods):
          if methodDocstring[n][i] == 0:
            methodIdx = i
            currentSignature = obj.__doc__[signaturePos[i]:obj.__doc__.find(")", signaturePos[i])+1]
            methodDocstring[n][i] = 1
            break

        signatureInLines = False
        for l in lines:
                if l.find(currentSignature) != -1:
                        signatureInLines = True
                        break

        if not signatureInLines:
                lines.insert(0, currentSignature)

        while len(lines) > 0 and lines[0].find(currentSignature) == -1:
          del lines[0]
        if len(lines) > 0 and lines[0].find(currentSignature) != -1:
          del lines[0]
        if len(lines) > 0 and methodIdx < nbMethods - 1:
          nextSignature = obj.__doc__[signaturePos[methodIdx+1]:obj.__doc__.find(")", signaturePos[methodIdx+1])+1]
          linesIdx = 0
          while lines[linesIdx].find(nextSignature) == -1:
            linesIdx+=1
            if linesIdx >= len(lines):
                break

          curNbLines = len(lines)
          for i in range(curNbLines - linesIdx):
            del lines[linesIdx]


def process_signature(app, what, name, obj, opts, sig, ann):
    global methodSignature
    currentSignature = ""
    n = name.replace("tulipgui.", "")
    n = n.replace("tulipogl.", "")
    n = n.replace("tulip.", "")
    if what != "class" and obj.__doc__ :
        nbMethods = 0
        pos = 0
        signaturePos = {}
        while obj.__doc__.find(n, pos) != -1:
            pos = obj.__doc__.find(n, pos)
            signaturePos[nbMethods] = pos
            pos += len(n)
            nbMethods+=1

        if not n in methodSignature.keys():
            methodSignature[n] = [0] * nbMethods


        for i in range(nbMethods):
            if methodSignature[n][i] == 0:
                currentSignature = obj.__doc__[signaturePos[i]:obj.__doc__.find(")", signaturePos[i])+1]
                methodSignature[n][i] = 1
                break

        idx1 = currentSignature.find("(")
        idx2 = currentSignature.find(")")
        if idx1 != -1 and idx2 != -1:
            s = currentSignature[idx1:idx2+1]
            if s != "" :
                sig = s
    return (sig, ann)

def setup(app):

    app.connect('autodoc-process-signature', process_signature) 
    app.connect('autodoc-process-docstring', process_docstring)