dcop Library API Documentation

stub.cpp

00001 /*****************************************************************
00002 Copyright (c) 1999 Torben Weis <weis@kde.org>
00003 Copyright (c) 2000 Matthias Ettrich <ettrich@kde.org>
00004 
00005 Permission is hereby granted, free of charge, to any person obtaining a copy
00006 of this software and associated documentation files (the "Software"), to deal
00007 in the Software without restriction, including without limitation the rights
00008 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
00009 copies of the Software, and to permit persons to whom the Software is
00010 furnished to do so, subject to the following conditions:
00011 
00012 The above copyright notice and this permission notice shall be included in
00013 all copies or substantial portions of the Software.
00014 
00015 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
00016 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
00017 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.  IN NO EVENT SHALL THE
00018 X CONSORTIUM BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN
00019 AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
00020 CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
00021 
00022 ******************************************************************/
00023 #include <qdom.h>
00024 #include <qfile.h>
00025 #include <qtextstream.h>
00026 #include <qstring.h>
00027 #include <qstringlist.h>
00028 
00029 #include <string.h>
00030 #include <stdlib.h>
00031 #include <stdio.h>
00032 #include <unistd.h>
00033 #include "main.h"
00034 #include "type.h"
00035 
00036 /*
00037  * Writes the stubs header
00038  */
00039 void generateStub( const QString& idl, const QString& filename, QDomElement de)
00040 {
00041     QFile stub( filename );
00042     if ( !stub.open( IO_WriteOnly ) )
00043     qFatal("Could not write to %s", filename.local8Bit().data() );
00044     
00045     QTextStream str( &stub );
00046 
00047     str << "/****************************************************************************" << endl;
00048     str << "**" << endl;
00049     str << "** DCOP Stub Definition created by dcopidl2cpp from " << idl << endl;
00050     str << "**" << endl;
00051     str << "** WARNING! All changes made in this file will be lost!" << endl;
00052     str << "**" << endl;
00053     str << "*****************************************************************************/" << endl;
00054     str << endl;
00055 
00056     QString ifdefstring = idl.upper();
00057     int pos = idl.findRev( '.' );
00058     if ( pos != -1 )
00059     ifdefstring = ifdefstring.left( pos );
00060 
00061     QString ifdefsuffix = "_STUB__";
00062     str << "#ifndef __" << ifdefstring << ifdefsuffix << endl;
00063     str << "#define __" << ifdefstring << ifdefsuffix << endl << endl;
00064 
00065     str << "#include <dcopstub.h>" << endl;
00066 
00067     QStringList includeslist, all_includes;
00068     QDomElement e = de.firstChild().toElement();
00069     for( ; !e.isNull(); e = e.nextSibling().toElement() ) {
00070     if ( e.tagName() == "INCLUDE" ) {
00071             // dcopidl lists the includes in reversed order because of the used yacc/bison gramatic
00072             // so let's reverse it back, as the order may be important
00073         includeslist.prepend( e.firstChild().toText().data());
00074             continue;
00075     }
00076         if( !includeslist.empty()) {
00077             for( QStringList::ConstIterator it = includeslist.begin();
00078                  it != includeslist.end();
00079                  ++it ) {
00080                 str << "#include <" << ( *it ) << ">" << endl;
00081                 all_includes.append( *it );
00082             }
00083             includeslist.clear();
00084         }
00085         if ( e.tagName() != "CLASS" )
00086         continue;
00087 
00088     str << endl;
00089     
00090     QDomElement n = e.firstChild().toElement();
00091     Q_ASSERT( n.tagName() == "NAME" );
00092     QString className = n.firstChild().toText().data() + ( "_stub" );
00093    
00094     //add link scope, if available
00095     n = n.nextSibling().toElement();
00096     QString linkScope;
00097     if (n.tagName()=="LINK_SCOPE") {
00098         linkScope = n.firstChild().toText().data() + " ";
00099         n = n.nextSibling().toElement();
00100     }
00101     
00102     // find dcop parent ( rightmost super class )
00103     QString DCOPParent;
00104     for( ; !n.isNull(); n = n.nextSibling().toElement() ) {
00105         if ( n.tagName() == "SUPER" )
00106         DCOPParent = n.firstChild().toText().data();
00107     }
00108     if( DCOPParent != "DCOPObject" ) { // we need to include the .h file for the base stub
00109         if( all_includes.contains( DCOPParent + ".h" ))
00110         str << "#include <" << DCOPParent << "_stub.h>" << endl;
00111         else if( all_includes.contains( DCOPParent.lower() + ".h" ))
00112         str << "#include <" << DCOPParent.lower() << "_stub.h>" << endl;
00113         else {// damn ... let's assume it's the last include
00114         QString stub_h = all_includes.last();
00115         unsigned int pos = stub_h.find( ".h" );
00116         if( pos > 0 ) {
00117             stub_h = stub_h.remove( pos, 100000 );
00118             str << "#include <" << stub_h << "_stub.h>" << endl;
00119         }
00120         else
00121             str << "#include <" << stub_h << ">" << endl;
00122         }
00123     }
00124 
00125     QString classNameFull = className; // class name with possible namespaces prepended
00126                        // namespaces will be removed from className now
00127     int namespace_count = 0;
00128     QString namespace_tmp = className;
00129     for(;;) {
00130         int pos = namespace_tmp.find( "::" );
00131         if( pos < 0 ) {
00132         className = namespace_tmp;
00133         break;
00134         }
00135         str << "namespace " << namespace_tmp.left( pos ) << " {" << endl;
00136         ++namespace_count;
00137         namespace_tmp = namespace_tmp.mid( pos + 2 );
00138     }
00139 
00140     str << endl;
00141 
00142     // Stub class definition
00143     str << "class " << linkScope <<className;
00144 
00145     // Parent : inherited interface stub or dcopstub
00146     if ( !DCOPParent.isEmpty() && DCOPParent != "DCOPObject" ) {
00147        str << " : ";
00148        str << "virtual public " << DCOPParent << "_stub";
00149     } else {
00150        str << " : virtual public DCOPStub";
00151     }
00152 
00153     str << endl;
00154     str << "{" << endl;
00155     str << "public:" << endl;
00156     
00157     // Constructors
00158     str << "    " << className << "( const QCString& app, const QCString& id );" << endl;
00159     str << "    " << className << "( DCOPClient* client, const QCString& app, const QCString& id );" << endl;
00160     str << "    explicit " << className << "( const DCOPRef& ref );" << endl;
00161 
00162     n = e.firstChild().toElement();
00163     for( ; !n.isNull(); n = n.nextSibling().toElement() ) {
00164         if (n.tagName() != "FUNC")
00165         continue;
00166         QDomElement r = n.firstChild().toElement();
00167         str << "    virtual "; // KDE4 - I really don't think these need to be virtual
00168         writeType( str, r );
00169 
00170         r = r.nextSibling().toElement();
00171         Q_ASSERT ( r.tagName() == "NAME" );
00172         str << r.firstChild().toText().data() << "(";
00173 
00174         bool first = true;
00175         r = r.nextSibling().toElement();
00176         for( ; !r.isNull(); r = r.nextSibling().toElement() ) {
00177         if ( !first )
00178             str << ", ";
00179         else
00180             str << " ";
00181         first = false;
00182         Q_ASSERT( r.tagName() == "ARG" );
00183         QDomElement a = r.firstChild().toElement();
00184         writeType( str, a );
00185         a = a.nextSibling().toElement();
00186         if ( a.tagName() == "NAME" )
00187             str << a.firstChild().toText().data();
00188         }
00189         if ( !first )
00190         str << " ";
00191         str << ")";
00192 
00193         //const methods stubs can't compile, they need to call setStatus().
00194         //if ( s.hasAttribute("qual") )
00195         //  str << " " << s.attribute("qual");
00196         str << ";" << endl;
00197     }
00198 
00199     // needed for inherited stubs
00200     str << "protected:" << endl;
00201     str << "    " << className << "() : DCOPStub( never_use ) {};" << endl;
00202 
00203     str << "};" << endl;
00204     str << endl;
00205 
00206     for(; namespace_count > 0; --namespace_count )
00207         str << "} // namespace" << endl;
00208     str << endl;
00209     }
00210 
00211     str << "#endif" << endl;
00212     stub.close();
00213 }
00214 
00215 // :set expandtab!<RETURN>:set ts=8<RETURN>:set sts=4<RETURN>:set sw=4<RETURN>
KDE Logo
This file is part of the documentation for dcop Library Version 3.3.90.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Mar 30 10:09:16 2005 by doxygen 1.3.9.1 written by Dimitri van Heesch, © 1997-2003