home *** CD-ROM | disk | FTP | other *** search
/ Maximum CD 2009 June / maximum-cd-2009-06.iso / DiscContents / OOo_3.0.1_Win32Intel_install_wJRE_en-US.exe / openofficeorg1.cab / uno.py < prev    next >
Encoding:
Python Source  |  2009-01-09  |  12.5 KB  |  359 lines
  1. #*************************************************************************
  2. #
  3. # DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  4. # 
  5. # Copyright 2008 by Sun Microsystems, Inc.
  6. #
  7. # OpenOffice.org - a multi-platform office productivity suite
  8. #
  9. # $RCSfile: uno.py,v $
  10. #
  11. # $Revision: 1.9 $
  12. #
  13. # This file is part of OpenOffice.org.
  14. #
  15. # OpenOffice.org is free software: you can redistribute it and/or modify
  16. # it under the terms of the GNU Lesser General Public License version 3
  17. # only, as published by the Free Software Foundation.
  18. #
  19. # OpenOffice.org is distributed in the hope that it will be useful,
  20. # but WITHOUT ANY WARRANTY; without even the implied warranty of
  21. # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22. # GNU Lesser General Public License version 3 for more details
  23. # (a copy is included in the LICENSE file that accompanied this code).
  24. #
  25. # You should have received a copy of the GNU Lesser General Public License
  26. # version 3 along with OpenOffice.org.  If not, see
  27. # <http://www.openoffice.org/license.html>
  28. # for a copy of the LGPLv3 License.
  29. #
  30. #*************************************************************************
  31. import sys
  32.  
  33. import pyuno
  34. import __builtin__
  35.  
  36. # all functions and variables starting with a underscore (_) must be considered private
  37. # and can be changed at any time. Don't use them
  38. _g_ctx = pyuno.getComponentContext( )
  39. _g_delegatee = __builtin__.__dict__["__import__"]
  40.  
  41. def getComponentContext():
  42.     """ returns the UNO component context, that was used to initialize the python runtime.
  43.     """ 
  44.     return _g_ctx      
  45.  
  46. def getConstantByName( constant ):
  47.     "Looks up the value of a idl constant by giving its explicit name"
  48.     return pyuno.getConstantByName( constant )
  49.  
  50. def getTypeByName( typeName):
  51.     """ returns a uno.Type instance of the type given by typeName. In case the
  52.         type does not exist, a com.sun.star.uno.RuntimeException is raised.
  53.     """ 
  54.     return pyuno.getTypeByName( typeName )
  55.  
  56. def createUnoStruct( typeName, *args ):
  57.     """creates a uno struct or exception given by typeName. The parameter args may
  58.     1) be empty. In this case, you get a default constructed uno structure.
  59.        ( e.g. createUnoStruct( "com.sun.star.uno.Exception" ) )
  60.     2) be a sequence with exactly one element, that contains an instance of typeName.
  61.        In this case, a copy constructed instance of typeName is returned
  62.        ( e.g. createUnoStruct( "com.sun.star.uno.Exception" , e ) )
  63.     3) be a sequence, where the length of the sequence must match the number of
  64.        elements within typeName (e.g.
  65.        createUnoStruct( "com.sun.star.uno.Exception", "foo error" , self) ). The
  66.        elements with in the sequence must match the type of each struct element,
  67.        otherwise an exception is thrown.
  68.     """
  69.     return getClass(typeName)( *args )
  70.  
  71. def getClass( typeName ):
  72.     """returns the class of a concrete uno exception, struct or interface
  73.     """
  74.     return pyuno.getClass(typeName)
  75.  
  76. def isInterface( obj ):
  77.     """returns true, when obj is a class of a uno interface"""
  78.     return pyuno.isInterface( obj )
  79.  
  80. def generateUuid():
  81.     "returns a 16 byte sequence containing a newly generated uuid or guid, see rtl/uuid.h "
  82.     return pyuno.generateUuid()        
  83.  
  84. def systemPathToFileUrl( systemPath ):
  85.     "returns a file-url for the given system path"
  86.     return pyuno.systemPathToFileUrl( systemPath )
  87.  
  88. def fileUrlToSystemPath( url ):
  89.     "returns a system path (determined by the system, the python interpreter is running on)"
  90.     return pyuno.fileUrlToSystemPath( url )
  91.  
  92. def absolutize( path, relativeUrl ):
  93.     "returns an absolute file url from the given urls"
  94.     return pyuno.absolutize( path, relativeUrl )
  95.  
  96. def getCurrentContext():
  97.     """Returns the currently valid current context.
  98.        see http://udk.openoffice.org/common/man/concept/uno_contexts.html#current_context
  99.        for an explanation on the current context concept
  100.     """
  101.     return pyuno.getCurrentContext()
  102.  
  103. def setCurrentContext( newContext ):
  104.     """Sets newContext as new uno current context. The newContext must
  105.     implement the XCurrentContext interface. The implemenation should
  106.     handle the desired properties and delegate unknown properties to the
  107.     old context. Ensure to reset the old one when you leave your stack ...
  108.     see http://udk.openoffice.org/common/man/concept/uno_contexts.html#current_context
  109.     """
  110.     return pyuno.setCurrentContext( newContext )
  111.  
  112.         
  113. class Enum:
  114.     "Represents a UNO idl enum, use an instance of this class to explicitly pass a boolean to UNO" 
  115.     #typeName the name of the enum as a string
  116.     #value    the actual value of this enum as a string
  117.     def __init__(self,typeName, value):
  118.         self.typeName = typeName
  119.         self.value = value
  120.         pyuno.checkEnum( self )
  121.  
  122.     def __repr__(self):
  123.         return "<uno.Enum %s (%r)>" % (self.typeName, self.value)
  124.  
  125.     def __eq__(self, that):
  126.         if not isinstance(that, Enum):
  127.             return False
  128.         return (self.typeName == that.typeName) and (self.value == that.value)
  129.  
  130. class Type:
  131.     "Represents a UNO type, use an instance of this class to explicitly pass a boolean to UNO"
  132. #    typeName                 # Name of the UNO type
  133. #    typeClass                # python Enum of TypeClass,  see com/sun/star/uno/TypeClass.idl
  134.     def __init__(self, typeName, typeClass):
  135.         self.typeName = typeName
  136.         self.typeClass = typeClass
  137.         pyuno.checkType(self)
  138.     def __repr__(self):
  139.         return "<Type instance %s (%r)>" % (self.typeName, self.typeClass)
  140.  
  141.     def __eq__(self, that):
  142.         if not isinstance(that, Type):
  143.             return False
  144.         return self.typeClass == that.typeClass and self.typeName == that.typeName
  145.  
  146.     def __hash__(self):
  147.         return self.typeName.__hash__()
  148.  
  149. class Bool(object):
  150.     """Represents a UNO boolean, use an instance of this class to explicitly 
  151.        pass a boolean to UNO.
  152.        Note: This class is deprecated. Use python's True and False directly instead
  153.     """
  154.     def __new__(cls, value):
  155.         if isinstance(value, (str, unicode)) and value == "true":
  156.             return True
  157.         if isinstance(value, (str, unicode)) and value == "false":
  158.             return False
  159.         if value:
  160.             return True
  161.         return False
  162.  
  163. class Char:
  164.     "Represents a UNO char, use an instance of this class to explicitly pass a char to UNO"
  165.     # @param value pass a Unicode string with length 1
  166.     def __init__(self,value):
  167.         assert isinstance(value, unicode)
  168.         assert len(value) == 1
  169.         self.value=value
  170.  
  171.     def __repr__(self):
  172.         return "<Char instance %s>" % (self.value, )
  173.         
  174.     def __eq__(self, that):
  175.         if isinstance(that, (str, unicode)):
  176.             if len(that) > 1:
  177.                 return False
  178.             return self.value == that[0]
  179.         if isinstance(that, Char):        
  180.             return self.value == that.value
  181.         return False
  182.  
  183. # Suggested by Christian, but still some open problems which need to be solved first
  184. #
  185. #class ByteSequence(str):
  186. #
  187. #    def __repr__(self):
  188. #        return "<ByteSequence instance %s>" % str.__repr__(self)
  189.  
  190.     # for a little bit compatitbility; setting value is not possible as 
  191.     # strings are immutable
  192. #    def _get_value(self):
  193. #        return self
  194. #
  195. #    value = property(_get_value)        
  196.  
  197. class ByteSequence:
  198.     def __init__(self, value):
  199.         if isinstance(value, str):
  200.             self.value = value
  201.         elif isinstance(value, ByteSequence):
  202.             self.value = value.value
  203.         else:
  204.             raise TypeError("expected string or bytesequence")
  205.  
  206.     def __repr__(self):
  207.         return "<ByteSequence instance '%s'>" % (self.value, )
  208.  
  209.     def __eq__(self, that):
  210.         if isinstance( that, ByteSequence):
  211.             return self.value == that.value
  212.         if isinstance(that, str):
  213.             return self.value == that
  214.         return False
  215.  
  216.     def __len__(self):
  217.         return len(self.value)
  218.  
  219.     def __getitem__(self, index):
  220.         return self.value[index]
  221.  
  222.     def __iter__( self ):
  223.         return self.value.__iter__()
  224.  
  225.     def __add__( self , b ):
  226.         if isinstance( b, str ):
  227.             return ByteSequence( self.value + b )
  228.         elif isinstance( b, ByteSequence ):
  229.             return ByteSequence( self.value + b.value )
  230.         raise TypeError( "expected string or ByteSequence as operand" )
  231.  
  232.     def __hash__( self ):
  233.         return self.value.hash()
  234.  
  235.  
  236. class Any:
  237.     "use only in connection with uno.invoke() to pass an explicit typed any"
  238.     def __init__(self, type, value ):
  239.         if isinstance( type, Type ):
  240.             self.type = type
  241.         else:
  242.             self.type = getTypeByName( type )
  243.         self.value = value
  244.  
  245. def invoke( object, methodname, argTuple ):
  246.     "use this function to pass exactly typed anys to the callee (using uno.Any)"
  247.     return pyuno.invoke( object, methodname, argTuple )
  248.     
  249. #---------------------------------------------------------------------------------------
  250. # don't use any functions beyond this point, private section, likely to change
  251. #---------------------------------------------------------------------------------------
  252. def _uno_import( name, *optargs ):
  253.     try:
  254. #       print "optargs = " + repr(optargs)
  255.         if len(optargs) == 0:
  256.            return _g_delegatee( name )
  257.            #print _g_delegatee
  258.         return _g_delegatee( name, *optargs )
  259.     except ImportError:
  260.         if len(optargs) != 3 or not optargs[2]:
  261.            raise
  262.     globals = optargs[0]
  263.     locals = optargs[1]
  264.     fromlist = optargs[2]
  265.     modnames = name.split( "." )
  266.     mod = None
  267.     d = sys.modules
  268.     for x in modnames:
  269.         if d.has_key(x):
  270.            mod = d[x]
  271.         else:
  272.            mod = pyuno.__class__(x)  # How to create a module ??
  273.         d = mod.__dict__
  274.  
  275.     RuntimeException = pyuno.getClass( "com.sun.star.uno.RuntimeException" )
  276.     for x in fromlist:
  277.        if not d.has_key(x):
  278.           if x.startswith( "typeOf" ):
  279.              try: 
  280.                 d[x] = pyuno.getTypeByName( name + "." + x[6:len(x)] )
  281.              except RuntimeException,e:
  282.                 raise ImportError( "type " + name + "." + x[6:len(x)] +" is unknown" )
  283.           else:
  284.             try:
  285.                 # check for structs, exceptions or interfaces
  286.                 d[x] = pyuno.getClass( name + "." + x )
  287.             except RuntimeException,e:
  288.                 # check for enums 
  289.                 try:
  290.                    d[x] = Enum( name , x )
  291.                 except RuntimeException,e2:
  292.                    # check for constants
  293.                    try:
  294.                       d[x] = getConstantByName( name + "." + x )
  295.                    except RuntimeException,e3:
  296.                       # no known uno type !
  297.                       raise ImportError( "type "+ name + "." +x + " is unknown" )
  298.     return mod
  299.  
  300. # hook into the __import__ chain    
  301. __builtin__.__dict__["__import__"] = _uno_import
  302.         
  303. # private function, don't use
  304. def _impl_extractName(name):
  305.     r = range (len(name)-1,0,-1)
  306.     for i in r:
  307.         if name[i] == ".":
  308.            name = name[i+1:len(name)]
  309.            break
  310.     return name            
  311.  
  312. # private, referenced from the pyuno shared library
  313. def _uno_struct__init__(self,*args):
  314.     if len(args) == 1 and hasattr(args[0], "__class__") and args[0].__class__ == self.__class__ :
  315.        self.__dict__["value"] = args[0]
  316.     else:
  317.        self.__dict__["value"] = pyuno._createUnoStructHelper(self.__class__.__pyunostruct__,args)
  318.     
  319. # private, referenced from the pyuno shared library
  320. def _uno_struct__getattr__(self,name):
  321.     return __builtin__.getattr(self.__dict__["value"],name)
  322.  
  323. # private, referenced from the pyuno shared library
  324. def _uno_struct__setattr__(self,name,value):
  325.     return __builtin__.setattr(self.__dict__["value"],name,value)
  326.  
  327. # private, referenced from the pyuno shared library
  328. def _uno_struct__repr__(self):
  329.     return repr(self.__dict__["value"])
  330.     
  331. def _uno_struct__str__(self):
  332.     return str(self.__dict__["value"])
  333.  
  334. # private, referenced from the pyuno shared library
  335. def _uno_struct__eq__(self,cmp):
  336.     if hasattr(cmp,"value"):
  337.        return self.__dict__["value"] == cmp.__dict__["value"]
  338.     return False
  339.  
  340. # referenced from pyuno shared lib and pythonscript.py
  341. def _uno_extract_printable_stacktrace( trace ):
  342.     mod = None
  343.     try:
  344.         mod = __import__("traceback")
  345.     except ImportError,e:
  346.         pass
  347.     ret = ""
  348.     if mod:
  349.         lst = mod.extract_tb( trace )
  350.         max = len(lst)
  351.         for j in range(max):
  352.             i = lst[max-j-1]
  353.             ret = ret + "  " + str(i[0]) + ":" + \
  354.                   str(i[1]) + " in function " + \
  355.                   str(i[2])  + "() [" + str(i[3]) + "]\n"
  356.     else:
  357.         ret = "Couldn't import traceback module"
  358.     return ret
  359.