1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_script_XLibraryAccess_idl__
24#define __com_sun_star_script_XLibraryAccess_idl__
25
26#ifndef __com_sun_star_uno_XInterface_idl__
27#include <com/sun/star/uno/XInterface.idl>
28#endif
29
30
31//=============================================================================
32
33 module com {  module sun {  module star {  module script {
34
35//=============================================================================
36/** provides access to additional scripting code.
37
38	<p>This code is organized in modules and these modules contain
39	the functions. It is possible to get just the code from a function,
40	but you can also get the whole code of a module with all functions in it.</p>
41	@deprecated
42 */
43published interface XLibraryAccess: com::sun::star::uno::XInterface
44{
45	//-------------------------------------------------------------------------
46	/** returns <TRUE/>, if the function is accessible through this library;
47		otherwise it returns <FALSE/>.
48
49				@param aFunctionName
50				the fully qualified name of a funtion.
51				(e.g., "UtilLibrary.ModuleDate.FunctionCurrentDate")
52	 */
53	boolean isFunction( [in] string aFunctionName );
54
55	//-------------------------------------------------------------------------
56	/** returns <TRUE/> if a fully qualified function name begins with this name.
57
58				@param aPathName
59				a part of a function name (e.g., "UtilLibrary").
60	 */
61	boolean isValidPath( [in] string aPathName );
62
63	//-------------------------------------------------------------------------
64	/** Return all module names which contain code.
65		 e.g., { "UtilLibrary.ModuleDate", "UtilLibrary.Output", ... }
66	 */
67	sequence<string> getModuleNames();
68
69	//-------------------------------------------------------------------------
70	/** get the source code of a module.
71	 */
72	string getModuleSource( [in] string aModulName );
73
74	//-------------------------------------------------------------------------
75	/** Get the hole compiled code of a module.
76
77		@param ModuleName the full qualified name of a module.
78							(e.g., "UtilLibrary.ModuleDate")
79		@return			an empty sequence, if this module is not found or the
80							code is not compiled.
81	 */
82	sequence<byte> getModuleCode( [in] string aModuleName );
83
84	//-------------------------------------------------------------------------
85	/** get the source code of a function.
86	 */
87	string getFunctionSource( [in] string aFunctionName );
88
89	//-------------------------------------------------------------------------
90	/** Get the compiled code of a function.
91
92		@param FunctionName the full qualified name of a function.
93							(e.g., "UtilLibrary.ModuleDate.Function.CurrentDate")
94		@return			an empty sequence, if this function is not found.
95	 */
96	sequence<byte> getFunctionCode( [in] string FunctionName );
97
98};
99
100//=============================================================================
101
102}; }; }; };
103
104#endif
105