home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / fnb101.zip / Lib / site-packages / Fnorb / orb / Util.py < prev    next >
Text File  |  1999-06-28  |  12KB  |  480 lines
  1. #!/usr/bin/env python
  2. #############################################################################
  3. # Copyright (C) DSTC Pty Ltd (ACN 052 372 577) 1997, 1998, 1999
  4. # All Rights Reserved.
  5. #
  6. # The software contained on this media is the property of the DSTC Pty
  7. # Ltd.  Use of this software is strictly in accordance with the
  8. # license agreement in the accompanying LICENSE.HTML file.  If your
  9. # distribution of this software does not contain a LICENSE.HTML file
  10. # then you have no rights to use this software in any manner and
  11. # should contact DSTC at the address below to determine an appropriate
  12. # licensing arrangement.
  13. # 
  14. #      DSTC Pty Ltd
  15. #      Level 7, GP South
  16. #      Staff House Road
  17. #      University of Queensland
  18. #      St Lucia, 4072
  19. #      Australia
  20. #      Tel: +61 7 3365 4310
  21. #      Fax: +61 7 3365 4311
  22. #      Email: enquiries@dstc.edu.au
  23. # 
  24. # This software is being provided "AS IS" without warranty of any
  25. # kind.  In no event shall DSTC Pty Ltd be liable for damage of any
  26. # kind arising out of or in connection with the use or performance of
  27. # this software.
  28. #
  29. # Project:      Fnorb
  30. # File:         $Source: /units/arch/src/Fnorb/orb/RCS/Util.py,v $
  31. # Version:      @(#)$RCSfile: Util.py,v $ $Revision: 1.15 $
  32. #
  33. #############################################################################
  34. """ Module for miscellaneous implementation dependent definitions! """
  35.  
  36.  
  37. # Standard/built-in modules.
  38. import keyword, new, string, UserList
  39.  
  40. # Fnorb extension modules.
  41. import cdr
  42.  
  43.  
  44. # The first four bytes of EVERY GIOP message header must contain this!
  45. MAGIC = ['G', 'I', 'O', 'P']
  46.  
  47. # The version of the GIOP specification that we are implementing.
  48. GIOP_VERSION_MAJOR = 1
  49. GIOP_VERSION_MINOR = 0
  50.  
  51. # The version of the 'cdr' extension module that we must have.
  52. CDR_VERSION = "1.1"
  53. if CDR_VERSION != cdr.version():
  54.     raise "Incompatible version of the 'cdr' extension module"
  55.  
  56. # Define the byte ordering appropriate for the host architecture.
  57. #
  58. # e.g DEC Alpha - LITTLE_ENDIAN
  59. #     Linux     - LITTLE_ENDIAN
  60. #     Solaris   - BIG_ENDIAN
  61. #
  62. # We get the byte order from the cdr extension module.  This is to try and
  63. # localise any parts of the code that require configuration for specific
  64. # architectures.
  65. HOST_BYTE_ORDER = cdr.host_byte_order()
  66.  
  67. # Byte ordering options for GIOP messages.
  68. BIG_ENDIAN    = 0
  69. LITTLE_ENDIAN = 1
  70.  
  71. # Threading models.
  72. REACTIVE = 0
  73. THREADED = 1
  74.  
  75. # Err, the default size of the thread pool ;^)
  76. DEFAULT_THREAD_POOL_SIZE = 10
  77.  
  78.  
  79. def python_name(name):
  80.     """ Add an underscore prefix to any name that is a Python keyword. """
  81.  
  82.     if keyword.iskeyword(name):
  83.     return '_' + name
  84.  
  85.     return name
  86.  
  87.  
  88. class Union:
  89.     """ Base class for unions. """
  90.  
  91.     def __init__(self, discriminator, value):
  92.     """ Constructor. """
  93.  
  94.     self.d = discriminator
  95.     self.v = value
  96.  
  97.     return
  98.  
  99.     def __getinitargs__(self):
  100.     """ Return the constructor arguments for unpickling. """
  101.  
  102.     return (self.d, self.v)
  103.  
  104.     def __str__(self):
  105.     """ Return a string representation of the union. """
  106.  
  107.     return "%s(%s, %s)" % (self.__class__.__name__,str(self.d),str(self.v))
  108.  
  109.  
  110. class Enum(UserList.UserList):
  111.     """ Base class for enumerations. """
  112.  
  113.     def __init__(self, id, data):
  114.     """ Constructor. """
  115.  
  116.     self._FNORB_ID = id
  117.     self.data = data
  118.  
  119.     return
  120.  
  121.     def __getinitargs__(self):
  122.     """ Return the constructor arguments for unpickling. """
  123.  
  124.     return (self._FNORB_ID, self.data)
  125.  
  126.  
  127. class EnumMember:
  128.     """ Enum member class. """
  129.  
  130.     def __init__(self, name, value):
  131.     """ Constructor. """
  132.  
  133.     self._name = name
  134.     self._value = value
  135.  
  136.     return
  137.  
  138.     def __getinitargs__(self):
  139.     """ Return the constructor arguments for unpickling. """
  140.  
  141.     return (self._name, self._value)
  142.  
  143.     def __cmp__(self, other):
  144.     """ Compare two enums. """
  145.  
  146.     return cmp(self._value, other._value)
  147.  
  148.     def __int__(self):
  149.     """ Return the enum as an 'integer' for array indexing etc. """
  150.  
  151.     return self._value
  152.  
  153.     def __hash__(self):
  154.     return self._value
  155.  
  156.     def __str__(self):
  157.     return self._name
  158.  
  159.     __repr__ = __str__
  160.  
  161.     def name(self):
  162.     return self._name
  163.  
  164.     def value(self):
  165.     return self._value
  166.  
  167.  
  168. class RepositoryId:
  169.     """ CORBA Interface Repository Ids.
  170.  
  171.     An Interface Repository id has three colon-separated parts:-
  172.     
  173.     1) The format of the repository id (currently we only support 'IDL')
  174.     2) The scoped name of the type definition
  175.     3) The version of the type definition
  176.     
  177.     eg:- 'IDL:Module/Interface/Hello:1.0'
  178.     
  179.     has parts:-
  180.  
  181.     1) IDL
  182.     2) Module/Interface/Hello
  183.     3) 1.0
  184.  
  185.     """
  186.     def __init__(self, str_id):
  187.     """ Constructor.
  188.  
  189.     'str_id' is the string representation of a repository id.
  190.  
  191.     """
  192.     # Initialise the instance from the string.
  193.     self._from_string(str_id)
  194.  
  195.     return
  196.  
  197.     def __getinitargs__(self):
  198.     """ Return the constructor arguments for unpickling. """
  199.  
  200.     return (str(self),)
  201.  
  202.     def __str__(self):
  203.     """ Return the string version of the repository id. """
  204.  
  205.     scoped_name = self._scoped_name.join('/')
  206.     return self._format + ':' + scoped_name + ':' + self._version
  207.  
  208.     def format(self):
  209.     """ Return the format.
  210.  
  211.     Currently this is ALWAYS 'IDL'.
  212.  
  213.     """
  214.     return self._format
  215.  
  216.     def scoped_name(self):
  217.     """ Return the scoped name. """
  218.  
  219.     return self._scoped_name
  220.     
  221.     def version(self):
  222.     """ Return the version. """
  223.  
  224.     return self._version
  225.  
  226.     def set_scoped_name(self, scoped_name):
  227.     """ Set the scoped name. """
  228.  
  229.     self._scoped_name = scoped_name
  230.     return
  231.  
  232.     def set_version(self, version):
  233.     """ Set the version. """
  234.  
  235.     self._version = version
  236.     return
  237.  
  238.     #########################################################################
  239.     # Internal methods.
  240.     #########################################################################
  241.  
  242.     def _from_string(self, str_id):
  243.     """ Initialise the repository id from a string.
  244.  
  245.     'str_id' is the string representation of a repository id.
  246.  
  247.     An Interface Repository id has three colon-separated parts:-
  248.     
  249.     1) The format of the repository id (currently we only support 'IDL')
  250.     2) The scoped name of the type definition
  251.     3) The version of the type definition
  252.     
  253.     eg:- 'IDL:Module/Interface/Hello:1.0'
  254.  
  255.     has parts:-
  256.  
  257.     1) IDL
  258.     2) Module/Interface/Hello
  259.     3) 1.0
  260.     
  261.     """
  262.     if len(str_id) == 0:
  263.         raise 'Invalid (empty) Repository Id.'
  264.  
  265.     else:
  266.         [self._format, temp_name, self._version] = string.split(str_id,':')
  267.         if self._format != 'IDL':
  268.         raise 'Invalid Repository Id.', str_id
  269.  
  270.         # Each scope in the type name is delimited by the '/' character.
  271.         temp_components = string.split(temp_name, '/')
  272.  
  273.         # 'Real' scoped names are separated by '::'!
  274.         self._scoped_name = ScopedName(string.join(temp_components, '::'))
  275.  
  276.     return
  277.  
  278.  
  279. class CompoundName:
  280.     """ Compound names.
  281.  
  282.     A compound name is made up of one or more components separated by a 
  283.     given character sequence (string).
  284.  
  285.     This class is an abstract class used to derive classes representing IDL
  286.     scoped names and Python package names.
  287.  
  288.     """
  289.     # The component separator (set in each concrete derived class).
  290.     _SEPARATOR = None
  291.  
  292.     def __init__(self, stringified_name=''):
  293.     """ Constructor.
  294.  
  295.     'stringified_name' is the string representation of the compound name.
  296.  
  297.     """
  298.     # Initialise the compound name from the string.
  299.     self._from_string(stringified_name)
  300.  
  301.     return
  302.  
  303.     def __add__(self, other):
  304.     """ Add two compound names. """
  305.  
  306.     new_name = new.instance(self.__class__, {})
  307.     new_name._components = self._components + other._components
  308.  
  309.     return new_name
  310.  
  311.     def __cmp__(self, other):
  312.     """ Compare two compound names. """
  313.  
  314.     return cmp(self._components, other._components)
  315.  
  316.     def __delitem__(self, i):
  317.     """ Delete the i'th component of the compound name. """
  318.  
  319.     del self._components[i]
  320.     return
  321.  
  322.     def __delslice__(self, i, j):
  323.     """ Delete the slice [i:j]. """
  324.  
  325.     del self._components[i:j]
  326.     return
  327.  
  328.     def __getitem__(self, i):
  329.     """ Get the i'th component of the compound name. """
  330.  
  331.     return self._components[i]
  332.  
  333.     def __getinitargs__(self):
  334.     """ Return the constructor arguments for unpickling. """
  335.  
  336.     return (str(self),)
  337.  
  338.     def __getslice__(self, i, j):
  339.     """ Return a new compound name consisting of the slice [i:j]. """
  340.  
  341.     new_name = new.instance(self.__class__, {})
  342.     new_name._components = self._components[i:j]
  343.  
  344.     return new_name
  345.  
  346.     def __len__(self):
  347.     """ Return the number of components in the compound name! """
  348.  
  349.     return len(self._components)
  350.  
  351.     def __mul__(self, n):
  352.     """ Multiply the compound name! """
  353.  
  354.     new_name = new.instance(self.__class__, {})
  355.     new_name._components = self._components * n
  356.  
  357.     return new_name
  358.  
  359.     def __setitem__(self, i, value):
  360.     """ Set the i'th component of the compound name. """
  361.  
  362.     self._components[i] = value
  363.     return
  364.  
  365.     def __setslice__(self, i, j, other):
  366.     """ Set the slice [i:j]. """
  367.  
  368.     self._components[i:j] = other._components[i:j]
  369.     return
  370.  
  371.     def __str__(self):
  372.     """ Return the string representation of the compound name. """
  373.  
  374.     return string.join(self._components, self._SEPARATOR)
  375.  
  376.     __repr__ = __str__
  377.  
  378.     def append(self, component):
  379.     """ Append onto a compound name. """
  380.  
  381.     self._components.append(component)
  382.     return
  383.  
  384.     def insert(self, i, component):
  385.     """ Insert into a compound name. """
  386.  
  387.     self._components.insert(i, component)
  388.     return
  389.  
  390.     def join(self, sep=' '):
  391.     """ Just like 'string.join' ;^) """
  392.  
  393.     return string.join(self._components, sep)
  394.  
  395.     def pythonise(self):
  396.     """ Fix up any clashes with Python keywords. """
  397.  
  398.     self._components = map(python_name, self._components)
  399.     return
  400.     
  401.     #########################################################################
  402.     # Internal methods.
  403.     #########################################################################
  404.  
  405.     def _from_string(self, stringified_name):
  406.     """ Initialise the compound name from a string. """
  407.  
  408.     # This is because string.split('', self._SEPARATOR) = [''] and not []!
  409.     if len(stringified_name) == 0:
  410.         self._components = []
  411.  
  412.     else:
  413.         self._components = string.split(stringified_name, self._SEPARATOR)
  414.  
  415.     return
  416.  
  417.  
  418. class ScopedName(CompoundName):
  419.     """ CORBA Interface Repository scoped names.
  420.  
  421.     A scoped name uniquely identifies modules, interfaces, constants,
  422.     typedefs, exceptions, attributes and operations within an Interface
  423.     Repository.
  424.  
  425.     A scoped name is a compound name made up of one or more identifiers
  426.     separated by "::".
  427.     
  428.     eg:- 'AModule::AnInterface::SomeContainedObject'
  429.  
  430.     """
  431.     # The component separator.
  432.     _SEPARATOR = '::'
  433.  
  434.  
  435. class PackageName(CompoundName):
  436.     """ Python package names.
  437.  
  438.     A package name is a compound name made up of one or more identifiers
  439.     separated by ".".
  440.     
  441.     eg:- 'Foo.Bar.Baz'
  442.  
  443.     """
  444.     # The component separator.
  445.     _SEPARATOR = '.'
  446.  
  447.  
  448. #############################################################################
  449. # Functions to stringify and unstringify Naming service names.
  450. #############################################################################
  451.  
  452. def _fnorb_name_to_string(name):
  453.     """ Convert a 'real' name into a stringified name! """
  454.  
  455.     components = []
  456.     for component in name:
  457.     components.append(component.id)
  458.     
  459.     # Backslashes are currently used to separate name components.
  460.     return 'name:' + string.join(components, '/')
  461.  
  462. def _fnorb_string_to_name(stringified_name):
  463.     """ Convert a stringified name into a 'real' name! """
  464.  
  465.     # fixme: We do the import here to get around the old circular import
  466.     # problems!
  467.     from Fnorb.cos.naming import CosNaming
  468.  
  469.     # Naming service names are simple lists of 'NameComponent's.
  470.     name = []
  471.  
  472.     # Backslashes are currently used to separate name components.
  473.     components = string.split(stringified_name[5:], '/')
  474.     for component in components:
  475.     name.append(CosNaming.NameComponent(component, ''))
  476.  
  477.     return name
  478.  
  479. #############################################################################
  480.