lasso.git - Unnamed repository; edit this file 'description' to name the repository.

diff options

Diffstat (limited to 'java/coldfusion/src')

0 files changed, 0 insertions, 0 deletions

n41'>41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460

#!/usr/bin/python
#
# Copyright (C) 2012-2013 Red Hat, Inc.  All rights reserved.
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
#
# Authors: Jan Safranek <jsafrane@redhat.com>
#

import os;
import pywbem;
import optparse
import re
import cgi
import sys

class HtmlExporter(object):
    
    def __init__(self, cliconn):
        self.classcache = {}
        self.cliconn = cliconn
        # original list of classes
        self.classes = []
        # set of all classes to print, i.e. incl. all parents
        self.queue = set()
        self.file = None

    def link(self, classname, attributename = ""):
        if attributename:
            link = classname + "-" + attributename
        else:
            link = classname
        link = link.replace("_","-")
        return link
        
    def print_escaped(self, string, prefix = ""):
        # replace \n with prefixes
        lines = string.split("\\n")
        for line in lines:
            print >>self.file, prefix + line
            print >>self.file, ""
    
    def load_class(self, classname):
        if classname in self.classcache:
            return self.classcache[classname]

        c = self.cliconn.GetClass(classname)
        self.classcache[classname] = c
        return c

    def source_class(self, c, param):
        """
            Find a class where a CIMMethod or CIMProperty is first defined.
            Start at class c and inspect all parents.
        """

        while True:

            if isinstance(param, pywbem.CIMMethod):
                if not c.methods.has_key(param.name):
                    break
            else:
                if not c.properties.has_key(param.name):
                    break

            if not c.superclass:
                # we're at the top class
                return c.classname
                
            parent = c
            c = self.load_class(c.superclass)
        return parent.classname

    def display_type(self, param):
        """
            Return displayable type of given parameter.
            It adds [] if it's array and class name of referenced classes.
        """
        url = False
        if param.reference_class:
            ptype = param.reference_class
            url = True
        else:
            ptype = param.type
        if param.is_array:
            ptype = ptype + "[]"
        if url:
            ptype = ":ref:`%s <%s>`" % (ptype, self.link(ptype))
        else:
            ptype = "``" + ptype + "``"
        return ptype

    def print_parameters(self, params):
        """
            Print table of method parametes.
        """
        function_indent = " "*4
        if not params:
            print >>self.file, "*None*"
            return

        for p in params.values():
            param_indent = " "*8
            direction = set()
            if p.qualifiers.has_key("Out"):
                direction.add("*OUT*")
            if p.qualifiers.has_key("In"):
                if p.qualifiers["In"].value:
                    direction.add("*IN*")
            if not direction:
                direction.add("*IN*")
            direction = ", ".join(sorted(direction))

            print >>self.file, param_indent + "%s %s **%s**" % (direction, self.display_type(p), p.name)
            self.print_qualifiers(p.qualifiers.values(), param_indent+ " "*4)
            print >>self.file, param_indent
        print >>self.file, function_indent

    def print_prototype(self, method):
        """ Print function prototype """
        self.file.write("``" + method.return_type + "`` ")
        self.file.write("**" + method.name + "** (")
        params = []
        for p in method.parameters.values():
            params.append((self.display_type(p) + " " + p.name))
        self.file.write(", ".join(params))
        self.file.write("\n")
        
    def print_table(self, col1, col2, indent):
        """
            Print table with two columns.
        """
        len1 = max(max(map(len, col1)), len("ValueMap"))
        len2 = max(max(map(len, col2)), len("Values"))
        separator = "="*len1 + " " + "="*len2
        print >>self.file, indent + separator
        print >>self.file, indent + format("ValueMap", str(len1)) + " " + format("Values", str(len2))
        print >>self.file, indent + separator
        for i in range(len(col1)):
            print >>self.file, indent + format(col1[i], str(len1)) + " " + format(col2[i], str(len2))
        print >>self.file, indent + separator

    def print_qualifiers(self, qualifiers, indent):
        """
            Print content of table of qualifiers.
            Only Deprecated, Description, Values and ValueMap are recognized.
        """
        deprecated = ""
        values = None
        maps = None
        for q in sorted(qualifiers):
            if q.name == "Deprecated":
                deprecated = "**Deprecated!** "
            if q.name == "Description":
                if deprecated:
                    print >>self.file, indent + deprecated
                self.print_escaped(q.value, indent)
            if q.name == "Values":
                values = q.value
            if q.name == "ValueMap":
                maps = q.value
        print >>self.file, indent
        if maps and values:
            self.print_table(maps, values, indent)
            print >>self.file, indent

    def compare_properties(self, p1, p2):
        """
            Compare two properties if they should printed in Inherited properties.
            Only Name, Description and Implemented are checked.
            Returns False, if the property should be printed in Local.
        """
        if p1.name != p2.name:
            return False
        d1 = p1.qualifiers.get("Description", None)
        d2 = p2.qualifiers.get("Description", None)
        if d1.value != d2.value:
            return False
        i1 = p1.qualifiers.get("Implemented", None)
        i2 = p2.qualifiers.get("Implemented", None)
        if i1 and i1.value and not (i2 and i2.value):
            return False
        return True

    def print_keys(self, c):
        print >>self.file, "Key properties"
        print >>self.file, "^^^^^^^^^^^^^^"
        print >>self.file, ""
        for prop in c.properties.values():
            if prop.qualifiers.has_key('Key'):
                src = self.source_class(c, prop)
                link = self.link(src, prop.name)
                print >>self.file, "| :ref:`%s <%s>`" % (prop.name, link)
        print >>self.file, ""

    def print_class(self, c):
        """
            Print one class, inc. header.
        """
        parent = None
        if c.superclass:
            parent = self.load_class(c.superclass)
            print >>self.file, "Subclass of :ref:`%s <%s>`" % (c.superclass, self.link(c.superclass))
            print >>self.file, ""

        description = c.qualifiers.get("Description", None)
        if not description:
            description = parent.qualifiers.get("Description", None)
        if description:
            self.print_escaped(description.value, "")
        print >>self.file, ""

        self.print_keys(c)

        local_props = []
        inherited_props = []
        for name in sorted(c.properties.keys()):
            if parent and parent.properties.has_key(name):
                inherited_props.append(c.properties[name])
                if not self.compare_properties(c.properties[name], parent.properties[name]):
                    # the property was overridden
                    local_props.append(c.properties[name])
            else:
                local_props.append(c.properties[name])

        local_methods = []
        inherited_methods = []
        for name in sorted(c.methods.keys()):
            if parent and parent.methods.has_key(name):
                inherited_methods.append(c.methods[name])
                if not self.compare_properties(c.methods[name], parent.methods[name]):
                    # the property was overridden
                    local_methods.append(c.methods[name])
            else:
                local_methods.append(c.methods[name])

        print >>self.file, "Local properties"
        print >>self.file, "^^^^^^^^^^^^^^^^"
        print >>self.file, ""
        if local_props:
            for prop in local_props:
                prop_link = self.link(c.classname, prop.name)
                print >>self.file, ".. _%s:" % (prop_link)
                print >>self.file, ""
                print >>self.file, "%s **%s**" % (self.display_type(prop), prop.name)
                print >>self.file, ""
                self.print_qualifiers(prop.qualifiers.values(), " "*4)
                print >>self.file, ""
        else:
            print >>self.file, "*None*"
            print >>self.file, ""

        print >>self.file, "Local methods"
        print >>self.file, "^^^^^^^^^^^^^"
        print >>self.file, ""
        if local_methods:
            for m in local_methods:
                link = self.link(c.classname, m.name)
                print >>self.file, "    .. _%s:" % (link)
                print >>self.file, ""
                self.print_prototype(m)
                print >>self.file, ""
                self.print_qualifiers(m.qualifiers.values(), " "*4)
                print >>self.file, "    **Parameters**"
                print >>self.file, "    "
                self.print_parameters(m.parameters)
                print >>self.file, "    "
        else:
            print >>self.file, "*None*"
            print >>self.file, ""

        print >>self.file, "Inherited properties"
        print >>self.file, "^^^^^^^^^^^^^^^^^^^^"
        print >>self.file, ""
        if inherited_props:
            for p in inherited_props:
                src = self.source_class(c, p)
                link = self.link(src, p.name)
                print >>self.file, "| %s :ref:`%s <%s>`" % (self.display_type(p), p.name, link)
            print >>self.file, ""
        else:
            print >>self.file, "*None*"
            print >>self.file, ""

        print >>self.file, "Inherited methods"
        print >>self.file, "^^^^^^^^^^^^^^^^^"
        print >>self.file, ""
        if inherited_methods:
            for m in inherited_methods:
                src = self.source_class(c, m)
                link = self.link(src, m.name)
                print >>self.file, "| :ref:`%s <%s>`" % (m.name, link)
            print >>self.file, ""
        else:
            print >>self.file, "*None*"
            print >>self.file, ""


    def print_file(self, filename):
        f = open(filename, "r")
        data = f.read()
        self.file.write(data)
        f.close()

    def print_page(self, c, header, footer):
        print "exporting ", c.classname
        self.file = open(c.classname + ".rst", "w")
        print >>self.file, ".. _%s:" % self.link(c.classname)
        print >>self.file, ""
        print >>self.file, c.classname
        print >>self.file, "-"*len(c.classname)
        print >>self.file, ""
#        if header:
#            self.print_file(header)
        self.print_class(c)
#        if footer:
#            self.print_file(footer)
        self.file.close()
        
    def add_class(self, classname):
        self.classes.append(classname)
        print "adding", classname
        self.queue.add(classname)
        # add all parents
        c = self.load_class(classname)
        parentname = c.superclass
        while parentname:
            if parentname in self.queue:
                break
            print "adding", parentname
            self.queue.add(parentname)
            c = self.load_class(parentname)
            parentname = c.superclass

    def export(self, header=None, footer=None):
        """
            Print everything, i.e. index.rst + all classes + all their parents.
        """
        # remove duplicate classes from the queue (and sort them)
        self.queue = sorted(self.queue)
        self.print_tree_rst(header, footer)
        self.print_index_rst(header, footer)
        while self.queue:
            c = self.queue.pop()
            self.print_page(self.load_class(c), header, footer)

    def _do_print_tree(self, name, subtree, level):
        nbsp=" |nbsp| "
        if level:
            print >>self.file, "|    "  + ("\\|"+nbsp*7)*(level-1) + "\\|---",
        else:
            print >>self.file, "|",
        if name in self.classes:
            print >>self.file, "\*",
        link = self.link(name)
        print >>self.file, ":ref:`%s <%s>`" % (name, link)
        for n in subtree.keys():
            self._do_print_tree(n, subtree[n], level+1)

    def print_tree(self):
        """
            Create inheritance tree of classes.
        """
        # hash classname -> list of hash of (direct) sublasses 
        subclasses = {}
        # hash classname -> nr. of its parents
        parents = {}
        # initialize the hash
        for cname in self.queue:
            subclasses[cname] = {}
            parents[cname] = 0

        # fill the hash
        for cname in self.queue:
            c = self.load_class(cname)
            if c.superclass:
                subclasses[c.superclass][cname] = subclasses[cname]
                parents[cname] += 1

        print >>self.file, ".. |nbsp| unicode:: 0xA0"


context:
space:
mode: