Mercurial > jwe > octave

changeset 20817:3d551b2ae928

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Use variable name nargin consistently in C++ code. * debug.cc (do_dbstack): Rename variable len to nargin. Change type to int from octave_idx_type. * dirfns.cc (Fcd): Rename variable argc to nargin and update code. Add nargin checking and print_usage. Replace make_argv call with xstring_value() call. Use !empty() rather than length > 0 for clarity. * error.cc (Flasterr, Flastwarn): Rename variable argc to nargin and update code. * filter.cc (Ffilter): Remove extra space in nargin declaration. * input.cc (Fecho): Rename variable argc to nargin and update code. * load-path.cc (Fpath): Rename variable argc to nargin and update code. Eliminate unnecessary declaration of "octave_value retval;". Add more calling forms to docstring. * pager.cc (Fdiary): Rename variable argc to nargin and update code. Replace make_argv call with xstring_value() call. Eliminate unnecessary declaration of "octave_value retval;".
author Rik <rik@octave.org>
date Mon, 07 Dec 2015 09:32:33 -0800
parents b16bcd7a2a33
children cef0448a6ed2
files libinterp/corefcn/debug.cc libinterp/corefcn/dirfns.cc libinterp/corefcn/error.cc libinterp/corefcn/filter.cc libinterp/corefcn/input.cc libinterp/corefcn/load-path.cc libinterp/corefcn/pager.cc
diffstat 7 files changed, 42 insertions(+), 50 deletions(-) [+]
line wrap: on
line diff
--- a/libinterp/corefcn/debug.cc	Mon Dec 07 08:30:51 2015 -0800
+++ b/libinterp/corefcn/debug.cc	Mon Dec 07 09:32:33 2015 -0800
@@ -1145,18 +1145,18 @@
 
   size_t nskip = 0;
 
-  octave_idx_type len = args.length ();
+  int nargin = args.length ();
 
   // dbstack accepts up to 2 arguments.
 
-  if (len > 2)
+  if (nargin > 2)
     print_usage ();
 
-  if (len == 1 || len == 2)
+  if (nargin == 1 || nargin == 2)
     {
       int n = 0;
 
-      for (octave_idx_type i = 0; i < len; i++)
+      for (octave_idx_type i = 0; i < nargin; i++)
         {
           octave_value arg = args(i);
 
--- a/libinterp/corefcn/dirfns.cc	Mon Dec 07 08:30:51 2015 -0800
+++ b/libinterp/corefcn/dirfns.cc	Mon Dec 07 09:32:33 2015 -0800
@@ -122,20 +122,21 @@
 @seealso{pwd, mkdir, rmdir, dir, ls}\n\
 @end deftypefn")
 {
-  octave_value_list retval;
+  int nargin = args.length ();
+ 
+  if (nargin > 1)
+    print_usage ();
 
-  int argc = args.length () + 1;
-
-  string_vector argv = args.make_argv ("cd");
+  octave_value_list retval;
 
   if (nargout > 0)
     retval = octave_value (octave_env::get_current_directory ());
 
-  if (argc > 1)
+  if (nargin == 1)
     {
-      std::string dirname = argv[1];
+      std::string dirname = args(0).xstring_value ("cd: DIR must be a string");
 
-      if (dirname.length () > 0)
+      if (! dirname.empty ())
         octave_change_to_directory (dirname);
     }
   else
--- a/libinterp/corefcn/error.cc	Mon Dec 07 08:30:51 2015 -0800
+++ b/libinterp/corefcn/error.cc	Mon Dec 07 09:32:33 2015 -0800
@@ -1961,25 +1961,24 @@
 @seealso{lasterror, error, lastwarn}\n\
 @end deftypefn")
 {
-  octave_value_list retval;
+  int nargin = args.length ();
 
-  int argc = args.length () + 1;
-
-  if (argc > 3)
+  if (nargin > 2)
     print_usage ();
 
+  octave_value_list retval;
   string_vector argv = args.make_argv ("lasterr");
 
   std::string prev_error_id = Vlast_error_id;
   std::string prev_error_message = Vlast_error_message;
 
-  if (argc > 2)
+  if (nargin == 2)
     Vlast_error_id = argv(2);
 
-  if (argc > 1)
+  if (nargin > 0)
     Vlast_error_message = argv(1);
 
-  if (argc == 1 || nargout > 0)
+  if (nargin == 0 || nargout > 0)
     {
       retval(1) = prev_error_id;
       retval(0) = prev_error_message;
@@ -2004,25 +2003,25 @@
 @seealso{warning, lasterror, lasterr}\n\
 @end deftypefn")
 {
-  octave_value_list retval;
 
-  int argc = args.length () + 1;
+  int nargin = args.length ();
 
-  if (argc > 3)
+  if (nargin > 2)
     print_usage ();
 
+  octave_value_list retval;
   string_vector argv = args.make_argv ("lastwarn");
 
   std::string prev_warning_id = Vlast_warning_id;
   std::string prev_warning_message = Vlast_warning_message;
 
-  if (argc > 2)
+  if (nargin == 2)
     Vlast_warning_id = argv(2);
 
-  if (argc > 1)
+  if (nargin > 0)
     Vlast_warning_message = argv(1);
 
-  if (argc == 1 || nargout > 0)
+  if (nargin == 0 || nargout > 0)
     {
       retval(1) = prev_warning_id;
       retval(0) = prev_warning_message;
--- a/libinterp/corefcn/filter.cc	Mon Dec 07 08:30:51 2015 -0800
+++ b/libinterp/corefcn/filter.cc	Mon Dec 07 09:32:33 2015 -0800
@@ -394,7 +394,7 @@
 {
   octave_value_list retval;
 
-  int nargin  = args.length ();
+  int nargin = args.length ();
 
   if (nargin < 3 || nargin > 5)
     print_usage ();
--- a/libinterp/corefcn/input.cc	Mon Dec 07 08:30:51 2015 -0800
+++ b/libinterp/corefcn/input.cc	Mon Dec 07 09:32:33 2015 -0800
@@ -973,13 +973,13 @@
 {
   octave_value_list retval;
 
-  int argc = args.length () + 1;
+  int nargin = args.length ();
 
   string_vector argv = args.make_argv ("echo");
 
-  switch (argc)
+  switch (nargin)
     {
-    case 1:
+    case 0:
       {
         if ((Vecho_executing_commands & ECHO_SCRIPTS)
             || (Vecho_executing_commands & ECHO_FUNCTIONS))
@@ -989,7 +989,7 @@
       }
       break;
 
-    case 2:
+    case 1:
       {
         std::string arg = argv[1];
 
@@ -1002,7 +1002,7 @@
       }
       break;
 
-    case 3:
+    case 2:
       {
         std::string arg = argv[1];
 
--- a/libinterp/corefcn/load-path.cc	Mon Dec 07 08:30:51 2015 -0800
+++ b/libinterp/corefcn/load-path.cc	Mon Dec 07 09:32:33 2015 -0800
@@ -2338,7 +2338,9 @@
 
 DEFUN (path, args, nargout,
        "-*- texinfo -*-\n\
-@deftypefn {Built-in Function} {} path (@dots{})\n\
+@deftypefn  {Built-in Function} {} path ()\n\
+@deftypefnx {Built-in Function} {@var{str} =} path ()\n\
+@deftypefnx {Built-in Function} {@var{str} =} path (@var{path1}, @dots{})\n\
 Modify or display Octave's load path.\n\
 \n\
 If @var{nargin} and @var{nargout} are zero, display the elements of\n\
@@ -2355,17 +2357,15 @@
 @seealso{addpath, rmpath, genpath, pathdef, savepath, pathsep}\n\
 @end deftypefn")
 {
-  octave_value retval;
-
-  int argc = args.length () + 1;
+  int nargin = args.length ();
 
   string_vector argv = args.make_argv ("path");
 
-  if (argc > 1)
+  if (nargin > 0)
     {
       std::string path = argv[1];
 
-      for (int i = 2; i < argc; i++)
+      for (int i = 2; i <= nargin; i++)
         path += dir_path::path_sep_str () + argv[i];
 
       load_path::set (path, true);
@@ -2374,8 +2374,8 @@
     }
 
   if (nargout > 0)
-    retval = load_path::path ();
-  else if (argc == 1 && nargout == 0)
+    return octave_value (load_path::path ());
+  else if (nargin == 0 && nargout == 0)
     {
       octave_stdout <<
         "\nOctave's search path contains the following directories:\n\n";
@@ -2386,8 +2386,6 @@
 
       octave_stdout << "\n";
     }
-
-  return retval;
 }
 
 DEFUN (addpath, args, nargout,
--- a/libinterp/corefcn/pager.cc	Mon Dec 07 08:30:51 2015 -0800
+++ b/libinterp/corefcn/pager.cc	Mon Dec 07 09:32:33 2015 -0800
@@ -539,26 +539,22 @@
 @seealso{history}\n\
 @end deftypefn")
 {
-  octave_value_list retval;
-
-  int argc = args.length () + 1;
+  int nargin = args.length ();
 
-  if (argc < 1 || argc > 2)
+  if (nargin > 1)
     print_usage ();
 
-  string_vector argv = args.make_argv ("diary");
-
   if (diary_file.empty ())
     diary_file = "diary";
 
-  if (argc == 1)
+  if (nargin == 0)
     {
       write_to_diary_file = ! write_to_diary_file;
       open_diary_file ();
     }
   else
     {
-      std::string arg = argv[1];
+      std::string arg = args(0).xstring_value ("diary: argument must be a string");
 
       if (arg == "on")
         {
@@ -577,8 +573,6 @@
           open_diary_file ();
         }
     }
-
-  return retval;
 }
 
 DEFUN (__diaryfile__, , ,