- rename end-user functions => prefix them with "atoms"
Pierre MARECHAL [Thu, 19 Mar 2009 09:32:35 +0000 (10:32 +0100)]
 - Update Copyright headers
 - Split end-user and internal functions

 => part II

15 files changed:
scilab/modules/atoms/etc/atoms.start
scilab/modules/atoms/macros/atomsCheck.sci
scilab/modules/atoms/macros/atomsGetInstalled.sci
scilab/modules/atoms/macros/atomsGetLoaded.sci
scilab/modules/atoms/macros/atomsInfo.sci
scilab/modules/atoms/macros/atomsInstall.sci
scilab/modules/atoms/macros/atomsInstallCategory.sci
scilab/modules/atoms/macros/atomsIsLoaded.sci
scilab/modules/atoms/macros/atomsList.sci
scilab/modules/atoms/macros/atomsRemove.sci
scilab/modules/atoms/macros/atomsSearch.sci
scilab/modules/atoms/macros/atomsUpdate.sci
scilab/modules/atoms/macros/buildmacros.sce
scilab/modules/atoms/tests/unit_tests/testfonctions.dia.ref
scilab/modules/atoms/tests/unit_tests/testfonctions.tst

index e22b362..7011110 100644 (file)
@@ -11,6 +11,7 @@
 // ====================================================================
 //Load  functions librarie
 load('SCI/modules/atoms/macros/lib');
+load('SCI/modules/scipad/macros/scipad_internals/lib');
 // ====================================================================
 //add help chapter
 add_module_help_chapter('atoms');
index 4fd3965..63431be 100644 (file)
@@ -1,5 +1,7 @@
 // Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 // Copyright (C) 2008 - INRIA - Delphine GASC <delphine.gasc@scilab.org>
+// Copyright (C) 2009 - DIGITEO - Sylvestre LEDRU <sylvestre.ledru@scilab.org>
+// Copyright (C) 2009 - DIGITEO - Pierre MARECHAL <pierre.marechal@scilab.org>
 //
 // This file must be used under the terms of the CeCILL.
 // This source file is licensed as described in the file COPYING, which
@@ -7,9 +9,11 @@
 // are also available at
 // http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
 
+// End user function
+
 // Verification that the toolbox is built correctly
 
-function result = checkToolbox(name)
+function result = atomsCheck(name)
   rhs=argn(2);
 
   if rhs == 1 then
@@ -58,7 +62,7 @@ function result = checkToolbox(name)
   result = %t
   return result
   else
-    error(msprintf(gettext("%s: Wrong number of input argument: %d expected.\n"),"checkToolbox",1));
+    error(msprintf(gettext("%s: Wrong number of input argument: %d expected.\n"),"atomsCheck",1));
   end
 endfunction
 
index cfe2615..30d43b9 100644 (file)
@@ -1,5 +1,7 @@
 // Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
-// Copyright (C) 2008 - INRIA - Simon LIPP <simon.lipp@inria.fr>
+// Copyright (C) 2008 - INRIA - Delphine GASC <delphine.gasc@scilab.org>
+// Copyright (C) 2009 - DIGITEO - Sylvestre LEDRU <sylvestre.ledru@scilab.org>
+// Copyright (C) 2009 - DIGITEO - Pierre MARECHAL <pierre.marechal@scilab.org>
 //
 // This file must be used under the terms of the CeCILL.
 // This source file is licensed as described in the file COPYING, which
@@ -7,9 +9,11 @@
 // are also available at
 // http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
 
+// End user function
+
 // List of installed toolboxes
 
-function tboxes = getInstalledToolboxes()
+function tboxes = atomsGetInstalled()
   reps = atomsToolboxDirectory()
   tboxes = []
   for i=1:size(reps, 1)
index 653bae3..126b0ad 100644 (file)
@@ -1,5 +1,7 @@
 // Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
-// Copyright (C) 2008 - INRIA - Simon LIPP <simon.lipp@inria.fr>
+// Copyright (C) 2008 - INRIA - Delphine GASC <delphine.gasc@scilab.org>
+// Copyright (C) 2009 - DIGITEO - Sylvestre LEDRU <sylvestre.ledru@scilab.org>
+// Copyright (C) 2009 - DIGITEO - Pierre MARECHAL <pierre.marechal@scilab.org>
 //
 // This file must be used under the terms of the CeCILL.
 // This source file is licensed as described in the file COPYING, which
@@ -7,9 +9,11 @@
 // are also available at
 // http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
 
+// End user function
+
 // List of registered toolboxes
 
-function loaded_toolboxes = getToolboxes()
+function loaded_toolboxes = atomsGetLoaded()
   if listfiles(TMPDIR + "/loaded_toolboxes") <> [] then
     load(TMPDIR + "/loaded_toolboxes", "loaded_toolboxes")
   else
index b0c88d8..73d0d0c 100644 (file)
@@ -1,5 +1,7 @@
 // Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 // Copyright (C) 2008 - INRIA - Delphine GASC <delphine.gasc@scilab.org>
+// Copyright (C) 2009 - DIGITEO - Sylvestre LEDRU <sylvestre.ledru@scilab.org>
+// Copyright (C) 2009 - DIGITEO - Pierre MARECHAL <pierre.marechal@scilab.org>
 //
 // This file must be used under the terms of the CeCILL.
 // This source file is licensed as described in the file COPYING, which
@@ -7,9 +9,11 @@
 // are also available at
 // http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
 
+// End user function
+
 // Display of the toolbox information
 
-function infoToolbox(nameToolbox)
+function atomsInfo(nameToolbox)
 
   rhs=argn(2);
 
@@ -67,7 +71,7 @@ function infoToolbox(nameToolbox)
     end
   end
   else
-    error(msprintf(gettext("%s: Wrong number of input argument: %d expected.\n"),"infoToolbox",1));
+    error(msprintf(gettext("%s: Wrong number of input argument: %d expected.\n"),"atomsInfo",1));
   end
 
 endfunction
index 2e20a58..5184b23 100644 (file)
@@ -1,5 +1,7 @@
 // Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 // Copyright (C) 2008 - INRIA - Delphine GASC <delphine.gasc@scilab.org>
+// Copyright (C) 2009 - DIGITEO - Sylvestre LEDRU <sylvestre.ledru@scilab.org>
+// Copyright (C) 2009 - DIGITEO - Pierre MARECHAL <pierre.marechal@scilab.org>
 //
 // This file must be used under the terms of the CeCILL.
 // This source file is licensed as described in the file COPYING, which
@@ -7,9 +9,11 @@
 // are also available at
 // http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
 
+// End user function
+
 // Installation of a toolbox
 
-function result = installToolbox(name, checkVersionScilab, version)
+function result = atomsInstall(name, checkVersionScilab, version)
   global conflictingList
   global conflictLocal
   global nomconflictLocal
@@ -72,7 +76,7 @@ function result = installToolbox(name, checkVersionScilab, version)
   return result
 
   else
-    error(msprintf(gettext("%s: Wrong number of input arguments: %d to %d expected.\n"),"installToolbox",1,3))
+    error(msprintf(gettext("%s: Wrong number of input arguments: %d to %d expected.\n"),"atomsInstall",1,3))
   end
 
 endfunction
index 1104d6a..d6f40f4 100644 (file)
@@ -1,5 +1,7 @@
 // Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 // Copyright (C) 2008 - INRIA - Delphine GASC <delphine.gasc@scilab.org>
+// Copyright (C) 2009 - DIGITEO - Sylvestre LEDRU <sylvestre.ledru@scilab.org>
+// Copyright (C) 2009 - DIGITEO - Pierre MARECHAL <pierre.marechal@scilab.org>
 //
 // This file must be used under the terms of the CeCILL.
 // This source file is licensed as described in the file COPYING, which
@@ -7,9 +9,11 @@
 // are also available at
 // http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
 
+// End user function
+
 // Installation of a toolbox sub-category  
 
-function result = installToolboxCategory(cat, sscat, checkVersionScilab)
+function result = atomsInstallCategory(cat, sscat, checkVersionScilab)
   rhs = argn(2)
 
   if (rhs == 2 | rhs == 1 | rhs == 3) then
@@ -26,8 +30,8 @@ function result = installToolboxCategory(cat, sscat, checkVersionScilab)
     regularExpression = "/" + cat + " \((\w*, )*" + sscat + "(, \w*)*\)/"
     // If yes, we install it if it is convenient for the Scilab version
     if regexp(catTool, regularExpression) <> [] & ((atomsVerifVersionScilab(desc("ScilabVersion")(i)) & checkVersionScilab) | ~checkVersionScilab)
-      // We can't take result = installToolbox() there is a install error, result = %f
-      installToolbox(desc("Toolbox")(i));
+      // We can't take result = atomsInstall() there is a install error, result = %f
+      atomsInstall(desc("Toolbox")(i));
       result = %t
     end   
   end
@@ -37,6 +41,6 @@ function result = installToolboxCategory(cat, sscat, checkVersionScilab)
   end
   return result
   else
-    error(msprintf(gettext("%s: Wrong number of input arguments: %d to %d expected.\n"),"installToolboxCategory",1,3))
+    error(msprintf(gettext("%s: Wrong number of input arguments: %d to %d expected.\n"),"atomsInstallCategory",1,3))
   end
 endfunction
index 85bd939..7f86d36 100644 (file)
@@ -1,5 +1,7 @@
 // Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 // Copyright (C) 2008 - INRIA - Simon LIPP <simon.lipp@inria.fr>
+// Copyright (C) 2009 - DIGITEO - Sylvestre LEDRU <sylvestre.ledru@scilab.org>
+// Copyright (C) 2009 - DIGITEO - Pierre MARECHAL <pierre.marechal@scilab.org>
 //
 // This file must be used under the terms of the CeCILL.
 // This source file is licensed as described in the file COPYING, which
@@ -7,14 +9,16 @@
 // are also available at
 // http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
 
+// End user function
+
 // If a toolbox is registered, return %t and its path ; %f else
 
-function [reg,path] = with_toolbox(name)
+function [reg,path] = atomsIsLoaded(name)
   if argn(2) == 1 then
   reg = %f
   path = ""
   
-  tboxes = getToolboxes()
+  tboxes = atomsGetLoaded()
   for i=1:size(tboxes, 1)
     if tboxes(i,1) == name then
          reg = %t
@@ -23,7 +27,7 @@ function [reg,path] = with_toolbox(name)
        end
   end  
   else
-    error(msprintf(gettext("%s: Wrong number of input argument: %d expected.\n"),"with_toolbox",1))
+    error(msprintf(gettext("%s: Wrong number of input argument: %d expected.\n"),"atomsIsLoaded",1))
   end
 
 endfunction
index 6ff758f..3eff6de 100644 (file)
@@ -1,5 +1,7 @@
 // Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 // Copyright (C) 2008 - INRIA - Delphine GASC <delphine.gasc@scilab.org>
+// Copyright (C) 2009 - DIGITEO - Sylvestre LEDRU <sylvestre.ledru@scilab.org>
+// Copyright (C) 2009 - DIGITEO - Pierre MARECHAL <pierre.marechal@scilab.org>
 //
 // This file must be used under the terms of the CeCILL.
 // This source file is licensed as described in the file COPYING, which
@@ -7,9 +9,11 @@
 // are also available at
 // http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
 
+// End user function
+
 // display of the local installed toolboxes
 
-function listToolboxes()
+function atomsList()
   rep = atomsToolboxDirectory()
   cd(rep)
   listLocal = ls()
index 17a8a46..a503586 100644 (file)
@@ -1,5 +1,7 @@
 // Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 // Copyright (C) 2008 - INRIA - Delphine GASC <delphine.gasc@scilab.org>
+// Copyright (C) 2009 - DIGITEO - Sylvestre LEDRU <sylvestre.ledru@scilab.org>
+// Copyright (C) 2009 - DIGITEO - Pierre MARECHAL <pierre.marechal@scilab.org>
 //
 // This file must be used under the terms of the CeCILL.
 // This source file is licensed as described in the file COPYING, which
@@ -7,9 +9,11 @@
 // are also available at
 // http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
 
+// End user function
+
 // Remove of a toolbox
 
-function result = removeToolbox(name)
+function result = atomsRemove(name)
   rhs=argn(2);
 
   if rhs == 1 then
@@ -52,7 +56,7 @@ function result = removeToolbox(name)
     return result
   end
   else
-    error(msprintf(gettext("%s: Wrong number of input argument: %d expected.\n"),"removeToolbox",1));
+    error(msprintf(gettext("%s: Wrong number of input argument: %d expected.\n"),"atomsRemove",1));
   end
 
 endfunction
index 1381cd1..2e0fdbe 100644 (file)
@@ -1,5 +1,7 @@
 // Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 // Copyright (C) 2008 - INRIA - Delphine GASC <delphine.gasc@scilab.org>
+// Copyright (C) 2009 - DIGITEO - Sylvestre LEDRU <sylvestre.ledru@scilab.org>
+// Copyright (C) 2009 - DIGITEO - Pierre MARECHAL <pierre.marechal@scilab.org>
 //
 // This file must be used under the terms of the CeCILL.
 // This source file is licensed as described in the file COPYING, which
@@ -7,9 +9,11 @@
 // are also available at
 // http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
 
+// End user function
+
 // Research of a toolbox
 
-function result = searchToolboxes(keyword, typeSearch)
+function result = atomsSearch(keyword, typeSearch)
   rhs = argn(2)
 
   if (rhs == 2 | rhs == 1) then
@@ -123,7 +127,7 @@ function result = searchToolboxes(keyword, typeSearch)
   end
   return result
   else
-    error(msprintf(gettext("%s: Wrong number of input arguments: %d to %d expected.\n"),"searchToolboxes",1,2))
+    error(msprintf(gettext("%s: Wrong number of input arguments: %d to %d expected.\n"),"atomsSearch",1,2))
   end
 
 
index 0d58010..8547bb8 100644 (file)
@@ -1,5 +1,7 @@
 // Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 // Copyright (C) 2008 - INRIA - Delphine GASC <delphine.gasc@scilab.org>
+// Copyright (C) 2009 - DIGITEO - Sylvestre LEDRU <sylvestre.ledru@scilab.org>
+// Copyright (C) 2009 - DIGITEO - Pierre MARECHAL <pierre.marechal@scilab.org>
 //
 // This file must be used under the terms of the CeCILL.
 // This source file is licensed as described in the file COPYING, which
@@ -7,9 +9,11 @@
 // are also available at
 // http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
 
+// End user function
+
 // update of a toolbox
 
-function result = updateToolbox(name, checkVersionScilab)
+function result = atomsUpdate(name, checkVersionScilab)
   rhs = argn(2)
 
   if (rhs == 2 | rhs == 1) then
@@ -25,7 +29,7 @@ function result = updateToolbox(name, checkVersionScilab)
     [n, m] = size(listLocal)
     for k=1:n
       if listLocal(i) <> ".svn"
-        if ~updateToolbox(listLocal(k))
+        if ~atomsUpdate(listLocal(k))
           break
         end
       end
@@ -99,7 +103,7 @@ function result = updateToolbox(name, checkVersionScilab)
           [signeNew, versionNew] = atomsSeparateSignVersion(versionNew)
           versionNew = atomsDecoupVersion(versionNew)
           if ((versionNew == "<=" | versionNew == "=")  & atomsCompareVersion(v1, versionNew) == -1) | ((versionNew == ">=" | versionNew == "=") & atomsCompareVersion(v1, versionNew) == 1) 
-            updateToolbox(dependsNew);
+            atomsUpdate(dependsNew);
           end
         end
       end
@@ -109,13 +113,13 @@ function result = updateToolbox(name, checkVersionScilab)
     atomsDisplayMessage(sprintf(_("The toolbox %s is going to be updated to version %s.\n"),name,versionNew))
     // We install the new version
     rmdir(rep + name, "s")
-    installToolbox(name);
+    atomsInstall(name);
   end
   result = %t
   return result
 
   else
-    error(msprintf(gettext("%s: Wrong number of input arguments: %d to %d expected.\n"),"updateToolbox",1,2))
+    error(msprintf(gettext("%s: Wrong number of input arguments: %d to %d expected.\n"),"atomsUpdate",1,2))
   end
 
 endfunction
index c238830..441ed1a 100644 (file)
@@ -1,6 +1,7 @@
 //------------------------------------
 // Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
-// Copyright (C) INRIA - Delphine Gasc (2008)
+// Copyright (C) 2008 - INRIA - Delphine GASC <delphine.gasc@scilab.org>
+// Copyright (C) 2009 - DIGITEO - Pierre MARECHAL <pierre.marechal@scilab.org>
 // 
 // This file must be used under the terms of the CeCILL.
 // This source file is licensed as described in the file COPYING, which
@@ -12,5 +13,6 @@ if (isdef('genlib') == %f) then
    exec(SCI+'/modules/functions/scripts/buildmacros/loadgenlib.sce');
 end
 
-genlib('atomslib','SCI/modules/atoms/macros',%f,%t); 
+genlib('atomslib','SCI/modules/atoms/macros',%f,%t);
+genlib('atomsinternalslib','SCI/modules/atoms/macros/atoms_internals',%f,%t);
 //------------------------------------
index ac5ba75..24f6c1a 100644 (file)
@@ -66,36 +66,36 @@ function listMirror = atomsToolboxMirror()
   listMirror = ["http://128.93.23.238/scilab/src/contrib", "http://128.93.23.238/scilab/bin/windows/contrib"];
 endfunction
 // installation avec la dernière dependance non présente sur le web ni en local
-if installToolbox("testA") <> %f then bugmes();quit;end;
+if atomsInstall("testA") <> %f then bugmes();quit;end;
  
  Toolbox testH not find   
  
  The Toolbox version testC locally present doesn't match. Update it.   
 // installation avec conflit versions
-if installToolbox("conflitA") <> %f then bugmes();quit;end;
+if atomsInstall("conflitA") <> %f then bugmes();quit;end;
  
  The Toolbox version conflitB locally present doesn't match. Update it. 
 // installation avec la dépendance locale ne vérifiant pas la condition
-if installToolbox("local1") <> %f then bugmes();quit;end;
+if atomsInstall("local1") <> %f then bugmes();quit;end;
  
  The Toolbox version local1 locally present doesn't match. Update it.   
 // supression de toolbox non présente
-if removeToolbox("non") <> %f then bugmes();quit;end;
+if atomsRemove("non") <> %f then bugmes();quit;end;
  
  The toolbox non is not installed   
 // update d'une toolbox non présente
-if updateToolbox("non") <> %f then bugmes();quit;end;
+if atomsUpdate("non") <> %f then bugmes();quit;end;
  
  The toolbox non is not installed   
 // update d'une toolbox non présente sur le net
-if updateToolbox("truc") <> %f then bugmes();quit;end;
+if atomsUpdate("truc") <> %f then bugmes();quit;end;
  
  Toolbox not available on the net   
 // update d'une toolbox dependance d'une autre
 function listMirror = atomsToolboxMirror()
   listMirror = ["http://128.93.23.238/scilab/src/contrib"];
 endfunction
-if installToolbox("updateA") <> %t then bugmes();quit;end;
+if atomsInstall("updateA") <> %t then bugmes();quit;end;
  
  Is going to be install : updateA   
  
@@ -104,22 +104,22 @@ function listMirror = atomsToolboxMirror()
   listMirror = ["http://128.93.23.238/scilab/src/contrib", "http://128.93.23.238/scilab/bin/macosX/contrib"];
 endfunction
 // Mauvaise version
-if updateToolbox("updateB") <> %f then bugmes();quit;end;
+if atomsUpdate("updateB") <> %f then bugmes();quit;end;
  
  Dependancie problem   
 function listMirror = atomsToolboxMirror()
   listMirror = ["http://128.93.23.238/scilab/src/contrib", "http://128.93.23.238/scilab/bin/windows/contrib"];
 endfunction
 // Bonne version
-if updateToolbox("updateB") <> %t then bugmes();quit;end;
+if atomsUpdate("updateB") <> %t then bugmes();quit;end;
  
  The toolbox updateB is going to be update in version 1.2.2   
  
  Is going to be install : updateB   
 // Suppression des toolboxes
-if removeToolbox("updateA") <> %t then bugmes();quit;end;
+if atomsRemove("updateA") <> %t then bugmes();quit;end;
  
  updateA delete   
-if removeToolbox("updateB") <> %t then bugmes();quit;end;
+if atomsRemove("updateB") <> %t then bugmes();quit;end;
  
  updateB delete   
index 9bae5ed..d682517 100644 (file)
@@ -70,35 +70,35 @@ function listMirror = atomsToolboxMirror()
 endfunction
 
 // installation avec la dernière dependance non présente sur le web ni en local
-if installToolbox("testA") <> %f then pause, end;
+if atomsInstall("testA") <> %f then pause, end;
 // installation avec conflit versions
-if installToolbox("conflitA") <> %f then pause, end;
+if atomsInstall("conflitA") <> %f then pause, end;
 // installation avec la dépendance locale ne vérifiant pas la condition
-if installToolbox("local1") <> %f then pause, end;
+if atomsInstall("local1") <> %f then pause, end;
 
 // supression de toolbox non présente
-if removeToolbox("non") <> %f then pause, end;
+if atomsRemove("non") <> %f then pause, end;
 
 // update d'une toolbox non présente
-if updateToolbox("non") <> %f then pause, end;
+if atomsUpdate("non") <> %f then pause, end;
 // update d'une toolbox non présente sur le net
-if updateToolbox("truc") <> %f then pause, end;
+if atomsUpdate("truc") <> %f then pause, end;
 // update d'une toolbox dependance d'une autre
 function listMirror = atomsToolboxMirror()
   listMirror = ["http://128.93.23.238/scilab/src/contrib"];
 endfunction
-if installToolbox("updateA") <> %t then pause, end;
+if atomsInstall("updateA") <> %t then pause, end;
 function listMirror = atomsToolboxMirror()
   listMirror = ["http://128.93.23.238/scilab/src/contrib", "http://128.93.23.238/scilab/bin/macosX/contrib"];
 endfunction
 // Mauvaise version
-if updateToolbox("updateB") <> %f then pause, end;
+if atomsUpdate("updateB") <> %f then pause, end;
 function listMirror = atomsToolboxMirror()
   listMirror = ["http://128.93.23.238/scilab/src/contrib", "http://128.93.23.238/scilab/bin/windows/contrib"];
 endfunction
 // Bonne version
-if updateToolbox("updateB") <> %t then pause, end;
+if atomsUpdate("updateB") <> %t then pause, end;
 // Suppression des toolboxes
-if removeToolbox("updateA") <> %t then pause, end;
-if removeToolbox("updateB") <> %t then pause, end;
+if atomsRemove("updateA") <> %t then pause, end;
+if atomsRemove("updateB") <> %t then pause, end;