File indexing completed on 2024-05-12 15:37:28

 # 
 # KDOM IDL parser
 #
 # Copyright (C) 2005 Nikolas Zimmermann <wildfox@kde.org>
 # 
 # This file is part of the KDE project
 # 
 # This library is free software; you can redistribute it and/or
 # modify it under the terms of the GNU Library General Public
 # License as published by the Free Software Foundation; either
 # version 2 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
 # Library General Public License for more details.
 # 
 # You should have received a copy of the GNU Library General Public License
 # aint with this library; see the file COPYING.LIB.  If not, write to
 # the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 # Boston, MA 02110-1301, USA.
 # 
 
 package IDLStructure;
 
 use Class::Struct;
 
 # Used to represent a parsed IDL document
 struct( idlDocument => {
     module => '$',   # Module identifier
     classes => '@',  # All parsed interfaces
     fileName => '$'  # file name
 });
 
 # Used to represent 'interface' / 'exception' blocks
 struct( domClass => {
     name => '$',      # Class identifier (without module)
     parents => '@',      # List of strings
     constants => '@',    # List of 'domConstant'
     functions => '@',    # List of 'domFunction'
     attributes => '@',    # List of 'domAttribute'    
     extendedAttributes => '$', # Extended attributes
 });
 
 # Used to represent domClass contents (name of method, signature)
 struct( domFunction => {
     signature => '$',    # Return type/Object name/extended attributes
     parameters => '@',    # List of 'domSignature'
     raisesExceptions => '@',  # Possibly raised exceptions.
 });
 
 # Used to represent domClass contents (name of attribute, signature)
 struct( domAttribute => {
     type => '$',              # Attribute type (including namespace)
     signature => '$',         # Attribute signature
     getterExceptions => '@',  # Possibly raised exceptions.
     setterExceptions => '@',  # Possibly raised exceptions.
 });
 
 # Used to represent a map of 'variable name' <-> 'variable type'
 struct( domSignature => {
     name => '$',      # Variable name
     type => '$',      # Variable type
     extendedAttributes => '$' # Extended attributes
 });
 
 # Used to represent string constants
 struct( domConstant => {
     name => '$',      # DOM Constant identifier
     type => '$',      # Type of data
     value => '$',      # Constant value
 });
 
 # Helpers
 $idlId = '[a-zA-Z0-9]';        # Generic identifier
 $idlIdNs = '[a-zA-Z0-9:]';      # Generic identifier including namespace
 $idlIdNsList = '[a-zA-Z0-9:,\ ]';  # List of Generic identifiers including namespace
 
 $idlType = '[a-zA-Z0-9_]';      # Generic type/"value string" identifier
 $idlDataType = '[a-zA-Z0-9\ ]';   # Generic data type identifier
 
 # Magic IDL parsing regular expressions
 my $supportedTypes = "((?:unsigned )?(?:int|short|long)|(?:$idlIdNs*))";
 
 # Special IDL notations
 $extendedAttributeSyntax = '\[[^]]*\]'; # Used for extended attributes
 
 # Regular expression based IDL 'syntactical tokenizer' used in the IDLParser
 $moduleSelector = 'module\s*(' . $idlId . '*)\s*{';
 $moduleNSSelector = 'module\s*(' . $idlId . '*)\s*\[ns\s*(' . $idlIdNs . '*)\s*(' . $idlIdNs . '*)\]\s*;';
 $constantSelector = 'const\s*' . $supportedTypes . '\s*(' . $idlType . '*)\s*=\s*(' . $idlType . '*)';
 $raisesSelector = 'raises\s*\((' . $idlIdNsList . '*)\s*\)';
 $getterRaisesSelector = '\bgetter\s+raises\s*\((' . $idlIdNsList . '*)\s*\)';
 $setterRaisesSelector = '\bsetter\s+raises\s*\((' . $idlIdNsList . '*)\s*\)';
 
 $typeNamespaceSelector = '((?:' . $idlId . '*::)*)\s*(' . $idlDataType . '*)';
 
 $exceptionSelector = 'exception\s*(' . $idlIdNs . '*)\s*([a-zA-Z\s{;]*};)';
 $exceptionSubSelector = '{\s*' . $supportedTypes . '\s*(' . $idlType . '*)\s*;\s*}';
 
 $interfaceSelector = 'interface\s*((?:' . $extendedAttributeSyntax . ' )?)(' . $idlIdNs . '*)\s*(?::(\s*[^{]*))?{([a-zA-Z0-9_=\s(),;:\[\]]*)';
 $interfaceMethodSelector = '\s*((?:' . $extendedAttributeSyntax . ' )?)' . $supportedTypes . '\s*(' . $idlIdNs . '*)\s*\(\s*([a-zA-Z0-9:\s,=\[\]]*)';
 $interfaceParameterSelector = 'in\s*((?:' . $extendedAttributeSyntax . ' )?)' . $supportedTypes . '\s*(' . $idlIdNs . '*)';
 
 $interfaceAttributeSelector = '\s*(readonly attribute|attribute)\s*(' . $extendedAttributeSyntax . ' )?' . $supportedTypes . '\s*(' . $idlType . '*)';
 
 1;