Atoms 0.2
[scilab.git] / scilab / modules / atoms / macros / atomsInfo.sci
1 // Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
2 // Copyright (C) 2008 - INRIA - Delphine GASC <delphine.gasc@scilab.org>
3 // Copyright (C) 2009 - DIGITEO - Sylvestre LEDRU <sylvestre.ledru@scilab.org>
4 // Copyright (C) 2009 - DIGITEO - Pierre MARECHAL <pierre.marechal@scilab.org>
5 //
6 // This file must be used under the terms of the CeCILL.
7 // This source file is licensed as described in the file COPYING, which
8 // you should have received as part of this distribution.  The terms
9 // are also available at
10 // http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11
12 // End user function
13
14 // Display of the toolbox information
15
16 function desc = atomsInfo(name)
17         
18         rhs  = argn(2);
19         
20         // Check number of input arguments
21         // =========================================================================
22         
23         if rhs < 1 | rhs > 2 then
24                 error(msprintf(gettext("%s: Wrong number of input argument: %d to %d expected.\n"),"atomsInfo",1,2));
25         end
26         
27         // Check input arguments dimensions
28         // =========================================================================
29         
30         if size(name,"*") <> 1 then
31                 error(msprintf(gettext("%s: Wrong size for input argument #%d: A single string expected.\n"),"atomsInfo",1));
32         end
33         
34         if rhs>1 & size(version,"*") <> 1 then
35                 error(msprintf(gettext("%s: Wrong size for input argument #%d: A single string expected.\n"),"atomsInfo",2));
36         end
37         
38         // Default value for version
39         // =========================================================================
40         if rhs<2 then
41                 version = [];
42         end
43         
44         // we remove the special characters
45         // =========================================================================
46         normalized_name = atomsNormalizeName(name);
47         
48         // We try to find the information locally
49         // =========================================================================
50         
51         if atomsIsInstalled(name,version) then
52                 desc = atomsReadDesc( pathconvert(atomsGetInstalledPath(name,version)+"/DESCRIPTION",%F) );
53         end
54         
55         // We try to find the information on the net
56         // =========================================================================
57         
58         
59         
60         
61
62
63
64
65
66
67
68 endfunction