APIExtractor is a huge amount of legacy code inherited from QtScriptGenerator,

but QtScriptGenerator itself isn't a library, this explains why libapiextractor
does not care about things that every library SHOULD care, symbol visibility and
binary compatibility.

This commit adds symbol visibility rules to libapiextractor as the first step to make
libapiextractor aware of binary compatibility.

This is also needed if we want to be able to compile and use libapiextractor
under Windows.

Note: Not all symbols were made public, just the symbols needed by shiboken,
boostpython and doc generators, because IMHO libapiextractor needs some love
and a API review. More symbols could be added later if needed.

Reviewed by Renato Araujo <[email protected]>

Author: hugopl

CMakeLists.txt

@@ -8,7 +8,7 @@ find_package(Qt4 4.5.0 REQUIRED)
 find_package(LibXml2 2.6.32 REQUIRED)
 find_package(LibXslt 1.1.19 REQUIRED)
 
-set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -DAPIEXTRACTOR_ENABLE_DUPLICATE_ENUM_VALUES")
+set(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -Wall -DAPIEXTRACTOR_ENABLE_DUPLICATE_ENUM_VALUES -DAPIEXTRACTOR_BUILD -fvisibility=hidden")
 
 set(apiextractor_MAJOR_VERSION 0)
 set(apiextractor_MINOR_VERSION 3)
@@ -92,6 +92,7 @@ add_custom_target(dist
         WORKING_DIRECTORY ${CMAKE_SOURCE_DIR})
 
 set(root_HEADERS
+apiextractormacros.h
 abstractmetalang.h
 apiextractor.h
 reporthandler.h

abstractmetabuilder.h

@@ -31,7 +31,7 @@
 
 #include <QtCore/QSet>
 
-class AbstractMetaBuilder
+class APIEXTRACTOR_API AbstractMetaBuilder
 {
 public:
     enum RejectReason {

abstractmetalang.h

@@ -42,7 +42,7 @@ class AbstractMetaEnumValue;
 class AbstractMetaEnum;
 class QPropertySpec;
 
-class Documentation
+class APIEXTRACTOR_API Documentation
 {
 public:
     enum Format {
@@ -80,7 +80,7 @@ class Documentation
 typedef QList<AbstractMetaField *> AbstractMetaFieldList;
 typedef QList<AbstractMetaArgument *> AbstractMetaArgumentList;
 typedef QList<AbstractMetaFunction *> AbstractMetaFunctionList;
-class AbstractMetaClassList : public  QList<AbstractMetaClass *>
+class APIEXTRACTOR_API AbstractMetaClassList : public  QList<AbstractMetaClass *>
 {
 public:
     AbstractMetaClass *findClass(const QString &name) const;
@@ -89,9 +89,7 @@ class AbstractMetaClassList : public  QList<AbstractMetaClass *>
 
 };
 
-
-
-class AbstractMetaAttributes
+class APIEXTRACTOR_API AbstractMetaAttributes
 {
 public:
     AbstractMetaAttributes() : m_attributes(0) {};
@@ -305,7 +303,7 @@ class AbstractMetaAttributes
 };
 
 
-class AbstractMetaType
+class APIEXTRACTOR_API AbstractMetaType
 {
 public:
     enum TypeUsagePattern {
@@ -610,7 +608,7 @@ class AbstractMetaType
     uint m_reserved : 25; // unused
 };
 
-class AbstractMetaVariable
+class APIEXTRACTOR_API AbstractMetaVariable
 {
 public:
     AbstractMetaVariable() : m_type(0) {}
@@ -651,7 +649,7 @@ class AbstractMetaVariable
 
 
 
-class AbstractMetaArgument : public AbstractMetaVariable
+class APIEXTRACTOR_API AbstractMetaArgument : public AbstractMetaVariable
 {
 public:
     AbstractMetaArgument() : m_argumentIndex(0) {};
@@ -736,7 +734,7 @@ class AbstractMetaField : public AbstractMetaVariable, public AbstractMetaAttrib
 };
 
 
-class AbstractMetaFunction : public AbstractMetaAttributes
+class APIEXTRACTOR_API AbstractMetaFunction : public AbstractMetaAttributes
 {
 public:
     enum FunctionType {
@@ -1255,7 +1253,7 @@ class AbstractMetaEnum : public AbstractMetaAttributes
 
 typedef QList<AbstractMetaEnum *> AbstractMetaEnumList;
 
-class AbstractMetaClass : public AbstractMetaAttributes
+class APIEXTRACTOR_API AbstractMetaClass : public AbstractMetaAttributes
 {
 public:
     enum FunctionQueryOption {

apiextractor.h

@@ -26,12 +26,13 @@
 
 #include "reporthandler.h"
 #include "abstractmetalang.h"
+#include "apiextractormacros.h"
 #include <QStringList>
 
 class AbstractMetaBuilder;
 class QIODevice;
 
-class ApiExtractor
+class APIEXTRACTOR_API ApiExtractor
 {
 public:
     ApiExtractor();

apiextractormacros.h

@@ -0,0 +1,20 @@
+#ifndef APIEXTRACTORMACROS_H
+#define APIEXTRACTORMACROS_H
+
+
+// APIEXTRACTOR_API is used for the public API symbols.
+#if defined _WIN32 || defined __CYGWIN__
+    #if APIEXTRACTOR_BUILD
+        #define APIEXTRACTOR_API __declspec(dllimport)
+    #else
+        #define APIEXTRACTOR_API __declspec(dllexport)
+    #endif
+#else
+    #if __GNUC__ >= 4
+        #define APIEXTRACTOR_API __attribute__ ((visibility("default")))
+    #else
+        #define APIEXTRACTOR_API
+    #endif
+#endif
+
+#endif

docparser.h

@@ -25,15 +25,14 @@
 
 #include <QString>
 #include <QDir>
-// #include <QtCore/QMap>
 
 #include "abstractmetalang.h"
 
 class QDomDocument;
 class QDomNode;
 class QXmlQuery;
 
-class DocParser
+class APIEXTRACTOR_API DocParser
 {
 public:
     DocParser();

fileout.h

@@ -27,8 +27,9 @@
 #include <QtCore/QObject>
 #include <QtCore/QFile>
 #include <QtCore/QTextStream>
+#include "apiextractormacros.h"
 
-class FileOut : public QObject
+class APIEXTRACTOR_API FileOut : public QObject
 {
 private:
     QByteArray tmp;

qtdocparser.h

@@ -26,7 +26,7 @@
 
 #include "docparser.h"
 
-class QtDocParser : public DocParser
+class APIEXTRACTOR_API QtDocParser : public DocParser
 {
 public:
     QtDocParser() {}

reporthandler.h

@@ -27,6 +27,7 @@
 #include <QtCore/QString>
 #include <QtCore/QSet>
 #include <cstring>
+#include "apiextractormacros.h"
 
 class ProgressAnimation
 {
@@ -75,7 +76,7 @@ class ProgressAnimation
     }
 };
 
-class ReportHandler
+class APIEXTRACTOR_API ReportHandler
 {
 public:
     enum DebugLevel { NoDebug, SparseDebug, MediumDebug, FullDebug };

typesystem.h

@@ -29,6 +29,7 @@
 #include <QtCore/QStringList>
 #include <QtCore/QMap>
 #include <QtCore/QDebug>
+#include "apiextractormacros.h"
 
 class Indentor;
 
@@ -46,7 +47,7 @@ extern QString stringsJavaLang;
 extern QString strings_jchar;
 extern QString strings_jobject;
 
-struct Include
+struct APIEXTRACTOR_API Include
 {
     enum IncludeType {
         IncludePath,
@@ -144,7 +145,7 @@ struct ArgumentOwner
     int index;
 };
 
-class CodeSnipFragment
+class APIEXTRACTOR_API CodeSnipFragment
 {
 private:
     const QString m_code;
@@ -161,7 +162,7 @@ class CodeSnipFragment
     QString code() const;
 };
 
-class CodeSnipAbstract
+class APIEXTRACTOR_API CodeSnipAbstract
 {
 public:
     QString code() const;
@@ -231,7 +232,7 @@ class TemplateInstance
 };
 
 
-class CodeSnip : public CodeSnipAbstract
+class APIEXTRACTOR_API CodeSnip : public CodeSnipAbstract
 {
 public:
     enum Position {
@@ -449,7 +450,7 @@ typedef QList<FieldModification> FieldModificationList;
 *   This info will be used later to create a fake AbstractMetaFunction which
 *   will be inserted into the right AbstractMetaClass.
 */
-struct AddedFunction
+struct APIEXTRACTOR_API AddedFunction
 {
     /// Function access types.
     enum Access {
@@ -582,7 +583,7 @@ class DocModification
 
 typedef QList<DocModification> DocModificationList;
 
-class TypeEntry
+class APIEXTRACTOR_API TypeEntry
 {
 public:
     enum Type {
@@ -1010,7 +1011,7 @@ class ArrayTypeEntry : public TypeEntry
 };
 
 
-class PrimitiveTypeEntry : public TypeEntry
+class APIEXTRACTOR_API PrimitiveTypeEntry : public TypeEntry
 {
 public:
     PrimitiveTypeEntry(const QString &name)
@@ -1316,7 +1317,7 @@ class FlagsTypeEntry : public TypeEntry
 };
 
 
-class ComplexTypeEntry : public TypeEntry
+class APIEXTRACTOR_API ComplexTypeEntry : public TypeEntry
 {
 public:
     enum TypeFlag {
@@ -1842,7 +1843,7 @@ struct TypeRejection
     QString enum_name;
 };
 
-class TypeDatabase
+class APIEXTRACTOR_API TypeDatabase
 {
     TypeDatabase();
     TypeDatabase(const TypeDatabase&);