/* * This file is part of the Shiboken Python Bindings Generator project. * * Copyright (C) 2009-2010 Nokia Corporation and/or its subsidiary(-ies). * * Contact: PySide team * * This program is free software; you can redistribute it and/or * modify it under the terms of the GNU General Public License * version 2 as published by the Free Software Foundation. * * This program 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 * General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program; if not, write to the Free Software * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA * 02110-1301 USA * */ #ifndef CPPGENERATOR_H #define CPPGENERATOR_H #include "shibokengenerator.h" #include "overloaddata.h" /** * The CppGenerator generate the implementations of C++ bindings classes. */ class CppGenerator : public ShibokenGenerator { public: CppGenerator(); protected: QString fileNameForClass(const AbstractMetaClass* metaClass) const; QList filterGroupedOperatorFunctions(const AbstractMetaClass* metaClass, uint query); void generateClass(QTextStream& s, const AbstractMetaClass* metaClass); void finishGeneration(); private: void writeConstructorNative(QTextStream& s, const AbstractMetaFunction* func); void writeDestructorNative(QTextStream& s, const AbstractMetaClass* metaClass); QString getVirtualFunctionReturnTypeName(const AbstractMetaFunction* func); void writeVirtualMethodNative(QTextStream& s, const AbstractMetaFunction* func); void writeMetaObjectMethod(QTextStream& s, const AbstractMetaClass* metaClass); void writeMetaCast(QTextStream& s, const AbstractMetaClass* metaClass); void writeMethodWrapperPreamble(QTextStream& s, OverloadData& overloadData); void writeConstructorWrapper(QTextStream& s, const AbstractMetaFunctionList overloads); void writeDestructorWrapper(QTextStream& s, const AbstractMetaClass* metaClass); void writeMethodWrapper(QTextStream& s, const AbstractMetaFunctionList overloads); void writeArgumentsInitializer(QTextStream& s, OverloadData& overloadData); void writeCppSelfDefinition(QTextStream& s, const AbstractMetaFunction* func, bool hasStaticOverload = false); void writeCppSelfDefinition(QTextStream& s, const AbstractMetaClass* metaClass, bool hasStaticOverload = false, bool cppSelfAsReference = false); void writeErrorSection(QTextStream& s, OverloadData& overloadData); void writeFunctionReturnErrorCheckSection(QTextStream& s, bool hasReturnValue = true); /// Writes the check section for the validity of wrapped C++ objects. void writeInvalidPyObjectCheck(QTextStream& s, const QString& pyObj); void writeTypeCheck(QTextStream& s, const AbstractMetaType* argType, QString argumentName, bool isNumber = false, QString customType = "", bool rejectNull = false); void writeTypeCheck(QTextStream& s, const OverloadData* overloadData, QString argumentName); void writeTypeDiscoveryFunction(QTextStream& s, const AbstractMetaClass* metaClass); void writeSetattroFunction(QTextStream& s, const AbstractMetaClass* metaClass); void writeGetattroFunction(QTextStream& s, const AbstractMetaClass* metaClass); /** * Writes Python to C++ conversions for arguments on Python wrappers. * If implicit conversions, and thus new object allocation, are needed, * code to deallocate a possible new instance is also generated. * \param s text stream to write * \param argType a pointer to the argument type to be converted * \param argName C++ argument name * \param pyArgName Python argument name * \param context the current meta class * \param defaultValue an optional default value to be used instead of the conversion result * \param castArgumentAsUnused if true the converted argument is cast as unused to avoid compiler warnings */ void writeArgumentConversion(QTextStream& s, const AbstractMetaType* argType, const QString& argName, const QString& pyArgName, const AbstractMetaClass* context = 0, const QString& defaultValue = QString(), bool castArgumentAsUnused = false); /** * Returns the AbstractMetaType for a function argument. * If the argument type was modified in the type system, this method will * try to build a new type based on the type name defined in the type system. * \param func The function which owns the argument. * \param argPos Argument position in the function signature. * Note that the position 0 represents the return value, and the function * parameters start counting on 1. * \param newType It is set to true if the type returned is a new object that must be deallocated. * \return The type of the argument indicated by \p argPos. */ const AbstractMetaType* getArgumentType(const AbstractMetaFunction* func, int argPos); void writePythonToCppTypeConversion(QTextStream& s, const AbstractMetaType* type, const QString& pyIn, const QString& cppOut, const AbstractMetaClass* context = 0, const QString& defaultValue = QString()); /// Writes the conversion rule for arguments of regular and virtual methods. void writeConversionRule(QTextStream& s, const AbstractMetaFunction* func, TypeSystem::Language language); /// Writes the conversion rule for the return value of a method. void writeConversionRule(QTextStream& s, const AbstractMetaFunction* func, TypeSystem::Language language, const QString& outputVar); /** * Set the Python method wrapper return value variable to Py_None if * there are return types different from void in any of the other overloads * for the function passed as parameter. * \param s text stream to write * \param func a pointer to the function that will possibly return Py_None * \param thereIsReturnValue indicates if the return type of any of the other overloads * for this function is different from 'void' */ void writeNoneReturn(QTextStream& s, const AbstractMetaFunction* func, bool thereIsReturnValue); /** * Writes the Python function wrapper overload decisor that selects which C++ * method/function to call with the received Python arguments. * \param s text stream to write * \param overloadData the overload data describing all the possible overloads for the function/method */ void writeOverloadedFunctionDecisor(QTextStream& s, const OverloadData& overloadData); /// Recursive auxiliar method to the other writeOverloadedFunctionDecisor. void writeOverloadedFunctionDecisorEngine(QTextStream& s, const OverloadData* parentOverloadData); /// Writes calls to all the possible method/function overloads. void writeFunctionCalls(QTextStream& s, const OverloadData& overloadData); /// Writes the call to a single function usually from a collection of overloads. void writeSingleFunctionCall(QTextStream& s, const OverloadData& overloadData, const AbstractMetaFunction* func = 0); void writeNamedArgumentResolution(QTextStream& s, const AbstractMetaFunction* func, bool usePyArgs); /// Returns a string containing the name of an argument for the given function and argument index. QString argumentNameFromIndex(const AbstractMetaFunction* func, int argIndex, const AbstractMetaClass** wrappedClass); void writeMethodCall(QTextStream& s, const AbstractMetaFunction* func, int maxArgs = 0); void writeClassRegister(QTextStream& s, const AbstractMetaClass* metaClass); void writeClassDefinition(QTextStream& s, const AbstractMetaClass* metaClass); void writeMethodDefinitionEntry(QTextStream& s, const AbstractMetaFunctionList overloads); void writeMethodDefinition(QTextStream& s, const AbstractMetaFunctionList overloads); /// Writes the implementation of all methods part of python sequence protocol void writeSequenceMethods(QTextStream& s, const AbstractMetaClass* metaClass); void writeTypeAsSequenceDefinition(QTextStream& s, const AbstractMetaClass* metaClass); /// Writes the struct PyMappingMethods for types thats supports the python mapping protocol void writeTypeAsMappingDefinition(QTextStream& s, const AbstractMetaClass* metaClass); void writeMappingMethods(QTextStream& s, const AbstractMetaClass* metaClass); void writeTypeAsNumberDefinition(QTextStream& s, const AbstractMetaClass* metaClass); void writeTpTraverseFunction(QTextStream& s, const AbstractMetaClass* metaClass); void writeTpClearFunction(QTextStream& s, const AbstractMetaClass* metaClass); void writeCopyFunction(QTextStream& s, const AbstractMetaClass *metaClass); void writeGetterFunction(QTextStream& s, const AbstractMetaField* metaField); void writeSetterFunction(QTextStream& s, const AbstractMetaField* metaField); void writeRichCompareFunction(QTextStream& s, const AbstractMetaClass* metaClass); void writeToPythonFunction(QTextStream& s, const AbstractMetaClass* metaClass); void writeEnumsInitialization(QTextStream& s, AbstractMetaEnumList& enums); void writeEnumInitialization(QTextStream& s, const AbstractMetaEnum* metaEnum); void writeSignalInitialization(QTextStream& s, const AbstractMetaClass* metaClass); void writeFlagsDefinition(QTextStream& s, const AbstractMetaEnum* cppEnum); void writeFlagsMethods(QTextStream& s, const AbstractMetaEnum* cppEnum); void writeFlagsToLong(QTextStream& s, const AbstractMetaEnum* cppEnum); void writeFlagsNonZero(QTextStream& s, const AbstractMetaEnum* cppEnum); void writeFlagsNumberMethodsDefinition(QTextStream& s, const AbstractMetaEnum* cppEnum); void writeFlagsBinaryOperator(QTextStream& s, const AbstractMetaEnum* cppEnum, QString pyOpName, QString cppOpName); void writeFlagsUnaryOperator(QTextStream& s, const AbstractMetaEnum* cppEnum, QString pyOpName, QString cppOpName, bool boolResult = false); /// Writes the function that registers the multiple inheritance information for the classes that need it. void writeMultipleInheritanceInitializerFunction(QTextStream& s, const AbstractMetaClass* metaClass); /// Writes the implementation of special cast functions, used when we need to cast a class with multiple inheritance. void writeSpecialCastFunction(QTextStream& s, const AbstractMetaClass* metaClass); void writeExtendedIsConvertibleFunction(QTextStream& s, const TypeEntry* externalType, const QList& conversions); void writeExtendedToCppFunction(QTextStream& s, const TypeEntry* externalType, const QList& conversions); void writeExtendedConverterInitialization(QTextStream& s, const TypeEntry* externalType, const QList& conversions); void writeParentChildManagement(QTextStream& s, const AbstractMetaFunction* func, bool userHeuristicForReturn); bool writeParentChildManagement(QTextStream& s, const AbstractMetaFunction* func, int argIndex, bool userHeuristicPolicy); void writeReturnValueHeuristics(QTextStream& s, const AbstractMetaFunction* func, const QString& self = PYTHON_SELF_VAR); void writeInitQtMetaTypeFunctionBody(QTextStream& s, const AbstractMetaClass* metaClass) const; /** * Returns the multiple inheritance initializer function for the given class. * \param metaClass the class for whom the function name must be generated. * \return name of the multiple inheritance information initializer function or * an empty string if there is no multiple inheritance in its ancestry. */ QString multipleInheritanceInitializerFunctionName(const AbstractMetaClass* metaClass); /// Returns a list of all classes to which the given class could be cast. QStringList getAncestorMultipleInheritance(const AbstractMetaClass* metaClass); /// Returns true if the given class supports the python number protocol bool supportsNumberProtocol(const AbstractMetaClass* metaClass); /// Returns true if the given class supports the python sequence protocol bool supportsSequenceProtocol(const AbstractMetaClass* metaClass); /// Returns true if the given class supports the python mapping protocol bool supportsMappingProtocol(const AbstractMetaClass* metaClass); /// Returns true if generator should produce getters and setters for the given class. bool shouldGenerateGetSetList(const AbstractMetaClass* metaClass); void writeHashFunction(QTextStream& s, const AbstractMetaClass* metaClass); /// Write default implementations for sequence protocol void writeStdListWrapperMethods(QTextStream& s, const AbstractMetaClass* metaClass); /// Helper function for writeStdListWrapperMethods. void writeIndexError(QTextStream& s, const QString& errorMsg); QString writeReprFunction(QTextStream& s, const AbstractMetaClass* metaClass); void writeRegisterType(QTextStream& s, const AbstractMetaClass* metaClass); void writeRegisterType(QTextStream& s, const AbstractMetaEnum* metaEnum); bool hasBoolCast(const AbstractMetaClass* metaClass) const; // Number protocol structure members names. static QHash m_nbFuncs; // Maps special function names to function parameters and return types // used by CPython API in the sequence protocol. QHash > m_sequenceProtocol; // Sequence protocol structure members names. static QHash m_sqFuncs; // Maps special function names to function parameters and return types // used by CPython API in the mapping protocol. QHash > m_mappingProtocol; // Mapping protocol structure members names. static QHash m_mpFuncs; static QString m_currentErrorCode; /// Helper class to set and restore the current error code. class ErrorCode { public: explicit ErrorCode(QString errorCode) { m_savedErrorCode = CppGenerator::m_currentErrorCode; CppGenerator::m_currentErrorCode = errorCode; } explicit ErrorCode(int errorCode) { m_savedErrorCode = CppGenerator::m_currentErrorCode; CppGenerator::m_currentErrorCode = QString::number(errorCode); } ~ErrorCode() { CppGenerator::m_currentErrorCode = m_savedErrorCode; } private: QString m_savedErrorCode; }; }; #endif // CPPGENERATOR_H