| Index: tools/nixysa/nixysa/globals_binding.py
|
| ===================================================================
|
| --- tools/nixysa/nixysa/globals_binding.py (revision 0)
|
| +++ tools/nixysa/nixysa/globals_binding.py (revision 0)
|
| @@ -0,0 +1,456 @@
|
| +#!/usr/bin/python2.4
|
| +#
|
| +# Copyright 2008 Google Inc.
|
| +#
|
| +# Licensed under the Apache License, Version 2.0 (the "License");
|
| +# you may not use this file except in compliance with the License.
|
| +# You may obtain a copy of the License at
|
| +#
|
| +# http://www.apache.org/licenses/LICENSE-2.0
|
| +#
|
| +# Unless required by applicable law or agreed to in writing, software
|
| +# distributed under the License is distributed on an "AS IS" BASIS,
|
| +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
| +# See the License for the specific language governing permissions and
|
| +# limitations under the License.
|
| +
|
| +"""globals binding model module.
|
| +
|
| +This module implement the glue funcitions for the globals binding model. This
|
| +is not really a binding model per-say, but a facility to expose global
|
| +functions and variables. This binding model isn't used on any type, but only
|
| +implicitly on namespaces.
|
| +"""
|
| +
|
| +import sys
|
| +import cpp_utils
|
| +
|
| +class InvalidUsage(Exception):
|
| + """Raised when the namespace is used as a type."""
|
| + pass
|
| +
|
| +
|
| +def JavaMemberString(scope, type_defn):
|
| + """Gets the representation of a member name in Java.
|
| +
|
| + Args:
|
| + scope: a Definition for the scope in which the expression will be written.
|
| + type_defn: a Definition for the type.
|
| +
|
| + Returns:
|
| + a string representing the type
|
| +
|
| + Raises:
|
| + InvalidUsage: always. This function should not be called for a namespace.
|
| + """
|
| + raise InvalidUsage
|
| +
|
| +
|
| +def CppTypedefString(scope, type_defn):
|
| + """Gets the representation of a type when used in a C++ typedef.
|
| +
|
| + Args:
|
| + scope: a Definition for the scope in which the expression will be written.
|
| + type_defn: a Definition for the type.
|
| +
|
| + Returns:
|
| + a (string, boolean) pair, the first element being the representation of
|
| + the type, the second element indicating whether or not the definition of
|
| + the type is needed for the expression to be valid.
|
| +
|
| + Raises:
|
| + InvalidUsage: always. This function should not be called for a namespace.
|
| + """
|
| + raise InvalidUsage
|
| +
|
| +
|
| +def CppMemberString(scope, type_defn):
|
| + """Gets the representation of a type when used as a C++ class member.
|
| +
|
| + Args:
|
| + scope: a Definition for the scope in which the expression will be written.
|
| + type_defn: a Definition for the type.
|
| +
|
| + Returns:
|
| + a (string, boolean) pair, the first element being the representation of
|
| + the type, the second element indicating whether or not the definition of
|
| + the type is needed for the expression to be valid.
|
| +
|
| + Raises:
|
| + InvalidUsage: always. This function should not be called for a namespace.
|
| + """
|
| + raise InvalidUsage
|
| +
|
| +
|
| +def CppReturnValueString(scope, type_defn):
|
| + """Gets the representation of a type when used as a C++ function return value.
|
| +
|
| + Args:
|
| + scope: a Definition for the scope in which the expression will be written.
|
| + type_defn: a Definition for the type.
|
| +
|
| + Returns:
|
| + a (string, boolean) pair, the first element being the representation of
|
| + the type, the second element indicating whether or not the definition of
|
| + the type is needed for the expression to be valid.
|
| +
|
| + Raises:
|
| + InvalidUsage: always. This function should not be called for a namespace.
|
| + """
|
| + raise InvalidUsage
|
| +
|
| +
|
| +def CppParameterString(scope, type_defn):
|
| + """Gets the representation of a type when used for a function parameter.
|
| +
|
| + Args:
|
| + scope: a Definition for the scope in which the expression will be written.
|
| + type_defn: a Definition for the type.
|
| +
|
| + Returns:
|
| + a (string, boolean) pair, the first element being the representation of
|
| + the type, the second element indicating whether or not the definition of
|
| + the type is needed for the expression to be valid.
|
| +
|
| + Raises:
|
| + InvalidUsage: always. This function should not be called for a namespace.
|
| + """
|
| + raise InvalidUsage
|
| +
|
| +
|
| +def CppMutableParameterString(scope, type_defn):
|
| + """Gets the representation of a type for a mutable function parameter.
|
| +
|
| + Args:
|
| + scope: a Definition for the scope in which the expression will be written.
|
| + type_defn: a Definition for the type.
|
| +
|
| + Returns:
|
| + a (string, boolean) pair, the first element being the string representing
|
| + the type, the second element indicating whether or not the definition of
|
| + the type is needed for the expression to be valid.
|
| +
|
| + Raises:
|
| + InvalidUsage: always. This function should not be called for a namespace.
|
| + """
|
| + raise InvalidUsage
|
| +
|
| +
|
| +def CppMutableToNonMutable(scope, type_defn, expr):
|
| + """Gets the string converting a mutable expression to a non-mutable one.
|
| +
|
| + Args:
|
| + scope: a Definition for the scope in which the expression will be written.
|
| + type_defn: a Definition for the type.
|
| + expr: a string for the mutable expression.
|
| +
|
| + Returns:
|
| + a string, which is the non-mutable expression.
|
| +
|
| + Raises:
|
| + InvalidUsage: always. This function should not be called for a namespace.
|
| + """
|
| + raise InvalidUsage
|
| +
|
| +
|
| +def CppBaseClassString(scope, type_defn):
|
| + """Gets the representation of a type for a base class.
|
| +
|
| + Args:
|
| + scope: a Definition for the scope in which the expression will be written.
|
| + type_defn: a Definition for the type.
|
| +
|
| + Returns:
|
| + a (string, boolean) pair, the first element being the string representing
|
| + the type, the second element indicating whether or not the definition of
|
| + the type is needed for the expression to be valid.
|
| +
|
| + Raises:
|
| + InvalidUsage: always. This function should not be called for a namespace.
|
| + """
|
| + raise InvalidUsage
|
| +
|
| +
|
| +def CppCallMethod(scope, type_defn, object_expr, mutable, method, param_exprs):
|
| + """Gets the representation of a member function call.
|
| +
|
| + Args:
|
| + scope: a Definition for the scope in which the expression will be written.
|
| + type_defn: a Definition, representing the type of the object being called.
|
| + object_expr: a string, which is the expression for the object being called.
|
| + mutable: a boolean, whether or not the 'object_expr' expression is mutable
|
| + or not
|
| + method: a Function, representing the function to call.
|
| + param_exprs: a list of strings, each being the expression for the value of
|
| + each parameter.
|
| +
|
| + Returns:
|
| + a string, which is the expression for the function call.
|
| +
|
| + Raises:
|
| + InvalidUsage: always. This function should not be called for a namespace.
|
| + """
|
| + raise InvalidUsage
|
| +
|
| +
|
| +def CppCallStaticMethod(scope, namespace, method, param_exprs):
|
| + """Gets the representation of a static function call.
|
| +
|
| + Args:
|
| + scope: a Definition for the scope in which the expression will be written.
|
| + namespace: a Definition, representing the namespace containing the function
|
| + being called.
|
| + method: a Function, representing the function to call.
|
| + param_exprs: a list of strings, each being the expression for the value of
|
| + each parameter.
|
| +
|
| + Returns:
|
| + a string, which is the expression for the function call.
|
| + """
|
| + namespace = namespace # silence gpylint.
|
| + return '%s(%s)' % (cpp_utils.GetScopedName(scope, method),
|
| + ', '.join(param_exprs))
|
| +
|
| +
|
| +def CppCallConstructor(scope, type_defn, method, param_exprs):
|
| + """Gets the representation of a constructor call.
|
| +
|
| + Args:
|
| + scope: a Definition for the scope in which the expression will be written.
|
| + type_defn: a Definition, representing the type of the object being called.
|
| + method: a Function, representing the constructor to call.
|
| + param_exprs: a list of strings, each being the expression for the value of
|
| + each parameter.
|
| +
|
| + Returns:
|
| + a string, which is the expression for the constructor call.
|
| +
|
| + Raises:
|
| + InvalidUsage: always. This function should not be called for a namespace.
|
| + """
|
| + raise InvalidUsage
|
| +
|
| +
|
| +def CppSetField(scope, type_defn, object_expr, field, param_expr):
|
| + """Gets the representation of an expression setting a field in an object.
|
| +
|
| + Args:
|
| + scope: a Definition for the scope in which the expression will be written.
|
| + type_defn: a Definition, representing the type of the object containing the
|
| + field being set.
|
| + object_expr: a string, which is the expression for the object containing
|
| + the field being set.
|
| + field: a string, the name of the field to be set.
|
| + param_expr: a strings, being the expression for the value to be set.
|
| +
|
| + Returns:
|
| + a string, which is the expression for setting the field.
|
| +
|
| + Raises:
|
| + InvalidUsage: always. This function should not be called for a namespace.
|
| + """
|
| + raise InvalidUsage
|
| +
|
| +
|
| +def CppGetField(scope, type_defn, object_expr, field):
|
| + """Gets the representation of an expression getting a field in an object.
|
| +
|
| + Args:
|
| + scope: a Definition for the scope in which the expression will be written.
|
| + type_defn: a Definition, representing the type of the object containing the
|
| + field being retrieved.
|
| + object_expr: a string, which is the expression for the object containing
|
| + the field being retrieved.
|
| + field: a string, the name of the field to be retrieved.
|
| +
|
| + Returns:
|
| + a string, which is the expression for getting the field.
|
| +
|
| + Raises:
|
| + InvalidUsage: always. This function should not be called for a namespace.
|
| + """
|
| + raise InvalidUsage
|
| +
|
| +
|
| +def CppSetStatic(scope, namespace, field, param_expr):
|
| + """Gets the representation of an expression setting a static field.
|
| +
|
| + Args:
|
| + scope: a Definition for the scope in which the expression will be written.
|
| + namespace: a Definition, representing the namespace containing the field
|
| + being set.
|
| + field: a string, the name of the field to be set.
|
| + param_expr: a strings, being the expression for the value to be set.
|
| +
|
| + Returns:
|
| + a string, which is the expression for setting the field.
|
| + """
|
| + namespace = namespace # silence gpylint.
|
| + return '%s = %s' % (cpp_utils.GetScopedName(scope, field), param_expr)
|
| +
|
| +
|
| +def CppGetStatic(scope, namespace, field):
|
| + """Gets the representation of an expression getting a static field.
|
| +
|
| + Args:
|
| + scope: a Definition for the scope in which the expression will be written.
|
| + namespace: a Definition, representing the namespace containing the field
|
| + being retrieved.
|
| + field: a string, the name of the field to be retrieved.
|
| +
|
| + Returns:
|
| + a string, which is the expression for getting the field.
|
| + """
|
| + namespace = namespace # silence gpylint.
|
| + return cpp_utils.GetScopedName(scope, field)
|
| +
|
| +
|
| +def JSDocTypeString(type_defn):
|
| + """Gets the representation of a type in JSDoc notation.
|
| +
|
| + Args:
|
| + type_defn: a Definition for the type.
|
| +
|
| + Returns:
|
| + a string that is the JSDoc notation of type_defn.
|
| + """
|
| + type_defn = type_defn.GetFinalType()
|
| + type_stack = type_defn.GetParentScopeStack()
|
| + name = type_defn.name
|
| + name = '.'.join([s.name for s in type_stack[1:]] + [name])
|
| + print >> sys.stderr, (
|
| + 'WARINING: %s : Global Binding not yet supported for JSDocs for type: %s'
|
| + % (type_defn.source, name))
|
| + return name
|
| +
|
| +
|
| +def NpapiBindingGlueHeader(scope, type_defn):
|
| + """Gets the NPAPI glue header for a given type.
|
| +
|
| + Args:
|
| + scope: a Definition for the scope in which the glue will be written.
|
| + type_defn: a Definition, representing the type.
|
| +
|
| + Returns:
|
| + a string, the glue header.
|
| +
|
| + Raises:
|
| + InvalidUsage: always. This function should not be called for a namespace.
|
| + """
|
| + raise InvalidUsage
|
| +
|
| +
|
| +def NpapiBindingGlueCpp(scope, type_defn):
|
| + """Gets the NPAPI glue implementation for a given type.
|
| +
|
| + Args:
|
| + scope: a Definition for the scope in which the glue will be written.
|
| + type_defn: a Definition, representing the type.
|
| +
|
| + Returns:
|
| + a string, the glue implementation.
|
| +
|
| + Raises:
|
| + InvalidUsage: always. This function should not be called for a namespace.
|
| + """
|
| + raise InvalidUsage
|
| +
|
| +
|
| +def NpapiDispatchFunctionHeader(scope, type_defn, variable, npp, success):
|
| + """Gets a header for NPAPI glue dispatch functions.
|
| +
|
| + This function creates a string containing a C++ code snippet that should be
|
| + included at the beginning of NPAPI glue dispatch functions like Invoke or
|
| + GetProperty. This code snippet will declare and initialize certain variables
|
| + that will be used in the dispatch functions, like the NPObject representing
|
| + the object, or a pointer to the NPP instance.
|
| +
|
| + Args:
|
| + scope: a Definition for the scope in which the glue will be written.
|
| + type_defn: a Definition, representing the type.
|
| + variable: a string, representing a name of a variable that can be used to
|
| + store a reference to the object.
|
| + npp: a string, representing the name of the variable that holds the pointer
|
| + to the NPP instance. Will be declared by the code snippet.
|
| + success: the name of a bool variable containing the current success status.
|
| + (is not declared by the code snippet).
|
| +
|
| + Returns:
|
| + a (string, string) pair, the first string being the code snippet, and the
|
| + second string being an expression to access the object.
|
| +
|
| + Raises:
|
| + InvalidUsage: always. This function should not be called for a namespace.
|
| + """
|
| + raise InvalidUsage
|
| +
|
| +
|
| +def NpapiFromNPVariant(scope, type_defn, input_expr, variable, success,
|
| + exception_context, npp):
|
| + """Gets the string to get a value from a NPVariant.
|
| +
|
| + This function creates a string containing a C++ code snippet that is used to
|
| + retrieve a value from a NPVariant. If an error occurs, like if the NPVariant
|
| + is not of the correct type, the snippet will set the success status variable
|
| + to false.
|
| +
|
| + Args:
|
| + scope: a Definition for the scope in which the glue will be written.
|
| + type_defn: a Definition, representing the type of the value.
|
| + input_expr: an expression representing the NPVariant to get the value from.
|
| + variable: a string, representing a name of a variable that can be used to
|
| + store a reference to the value.
|
| + success: the name of a bool variable containing the current success status.
|
| + exception_context: the name of a string containing context information, for
|
| + use in exception reporting.
|
| + npp: a string, representing the name of the variable that holds the pointer
|
| + to the NPP instance.
|
| +
|
| + Returns:
|
| + a (string, string) pair, the first string being the code snippet and the
|
| + second one being the expression to access that value.
|
| +
|
| + Raises:
|
| + InvalidUsage: always. This function should not be called for a namespace.
|
| + """
|
| + raise InvalidUsage
|
| +
|
| +
|
| +def NpapiExprToNPVariant(scope, type_defn, variable, expression, output,
|
| + success, npp):
|
| + """Gets the string to store a value into a NPVariant.
|
| +
|
| + This function creates a string containing a C++ code snippet that is used to
|
| + store a value into a NPVariant. That operation takes two phases, one that
|
| + allocates necessary NPAPI resources, and that can fail, and one that actually
|
| + sets the NPVariant (that can't fail). If an error occurs, the snippet will
|
| + set the success status variable to false.
|
| +
|
| + Args:
|
| + scope: a Definition for the scope in which the glue will be written.
|
| + type_defn: a Definition, representing the type of the value.
|
| + variable: a string, representing a name of a variable that can be used to
|
| + store a reference to the value.
|
| + expression: a string representing the expression that yields the value to
|
| + be stored.
|
| + output: an expression representing a pointer to the NPVariant to store the
|
| + value into.
|
| + success: the name of a bool variable containing the current success status.
|
| + npp: a string, representing the name of the variable that holds the pointer
|
| + to the NPP instance.
|
| +
|
| + Returns:
|
| + a (string, string) pair, the first string being the code snippet for the
|
| + first phase, and the second one being the code snippet for the second phase.
|
| +
|
| + Raises:
|
| + InvalidUsage: always. This function should not be called for a namespace.
|
| + """
|
| + raise InvalidUsage
|
| +
|
| +
|
| +def main():
|
| + pass
|
| +
|
| +if __name__ == '__main__':
|
| + main()
|
|
|
| Property changes on: tools/nixysa/nixysa/globals_binding.py
|
| ___________________________________________________________________
|
| Added: svn:eol-style
|
| + LF
|
|
|
|
|
Chromium Code Reviews
