KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectweb > corba > command > api > CIDLtoCIF


1 /*====================================================================
2
3 OpenCCM: The Open CORBA Component Model Platform
4 Copyright (C) 2000-2004 INRIA & USTL - LIFL - GOAL
5 Contact: openccm@objectweb.org
6
7 This library is free software; you can redistribute it and/or
8 modify it under the terms of the GNU Lesser General Public
9 License as published by the Free Software Foundation; either
10 version 2.1 of the License, or any later version.
11
12 This library is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 Lesser General Public License for more details.
16
17 You should have received a copy of the GNU Lesser General Public
18 License along with this library; if not, write to the Free Software
19 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
20 USA
21
22 Initial developer(s): Christophe Demarey, Philippe Merle.
23 Contributor(s): ______________________________________.
24
25 ====================================================================*/

26
27 package org.objectweb.corba.command.api;
28
29 // Package dependencies
30
import org.objectweb.openccm.ast.api.FileScope;
31 import org.objectweb.openccm.command.api.Compiler;
32 import org.objectweb.openccm.command.api.Generator;
33
34 /**
35  * Interface of the cidl_cif command.
36  *
37  * @author <a HREF="mailto:Christophe.Demarey@lifl.fr">Christophe Demarey</a>
38  * <a HREF="mailto:Philippe.Merle@lifl.fr">Philippe Merle</a>
39  *
40  * @version 1.1
41  */

42
43 public interface CIDLtoCIF
44          extends Compiler JavaDoc,
45                  Generator
46 {
47     /**
48      * Obtains CIF skeletons output directory.
49      *
50      * @result The CIF skeletons output directory.
51      */

52     public String JavaDoc
53     getCIFOutputDirectory();
54
55     /**
56      * Obtains CIDL dependencies output directory.
57      *
58      * @result The output directory.
59      */

60     public String JavaDoc
61     getDependenciesOutputDirectory();
62
63     /**
64      * Obtains unwanted prefixs for CIDL dependencies.
65      *
66      * @result The list of prefixs.
67      */

68     public String JavaDoc[]
69     getNoPrefix();
70
71     /**
72      * Generates CIF interfaces and skeletons
73      * from an AST FileScope instance.
74      *
75      * Note that checkComponentRepository() and initAST() methods
76      * must be called before.
77      *
78      * @param filescope The source AST FileScope returned by the compile() method.
79      * @param inputfile - The source file.
80      * @param outputfile - The file name for the IDL mapping.
81      * @param base_dir - The base directory for java mapping.
82      * @param userIncludes - User files to include "...".
83      *
84      * @return True if ok, else false.
85      */

86     public boolean
87     generate_cif(FileScope filescope,
88                  String JavaDoc inputfile,
89                  String JavaDoc outputfile,
90                  String JavaDoc base_dir,
91                  String JavaDoc[] userIncludes);
92
93     /**
94      * Generates CIF dependencies from an AST FileScope instance.
95      *
96      * Note that checkComponentRepository() and initAST() methods
97      * must be called before.
98      *
99      * @param filescope - The source AST FileScope returned by the compile() method.
100      * @param base_dir - The base directory for dependencies output.
101      * @param unwanted_prefixs - Unwanted prefixs for CIDL dependencies.
102      *
103      * @return True if ok, else false.
104      */

105     public boolean
106     generate_cif_dependencies(FileScope filescope,
107                               String JavaDoc base_dir,
108                               String JavaDoc[] unwanted_prefixs);
109 }
110
Popular Tags