annotate src/DLD-FUNCTIONS/md5sum.cc @ 9064:7c02ec148a3c

Check grammar on all .cc files Same check as previously done on .m files Attempt to enforce some conformity in documentation text for rules such as two spaces after a period, commas around latin abbreviations, etc.
author Rik <rdrider0-list@yahoo.com>
date Sat, 28 Mar 2009 13:57:22 -0700
parents 93c65f2a5668
children 16f53d29049f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6375
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
1 /*
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
2
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
3 Copyright (C) 2007 David Bateman
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
4
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
5
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
6 This file is part of Octave.
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
7
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
8 Octave is free software; you can redistribute it and/or modify it
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
9 under the terms of the GNU General Public License as published by the
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6383
diff changeset
10 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6383
diff changeset
11 option) any later version.
6375
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
12
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
13 Octave is distributed in the hope that it will be useful, but WITHOUT
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
15 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
16 for more details.
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
17
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
18 You should have received a copy of the GNU General Public License
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6383
diff changeset
19 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6383
diff changeset
20 <http://www.gnu.org/licenses/>.
6375
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
21
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
22 */
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
23
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
24 #include <string>
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
25 #include <vector>
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
26
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
27 #ifdef HAVE_CONFIG_H
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
28 #include "config.h"
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
29 #endif
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
30
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
31 #include "defun-dld.h"
6383
65e9cf5c7718 [project @ 2007-03-05 22:03:31 by dbateman]
dbateman
parents: 6375
diff changeset
32 #include "file-stat.h"
65e9cf5c7718 [project @ 2007-03-05 22:03:31 by dbateman]
dbateman
parents: 6375
diff changeset
33 #include "file-ops.h"
65e9cf5c7718 [project @ 2007-03-05 22:03:31 by dbateman]
dbateman
parents: 6375
diff changeset
34 #include "gripes.h"
65e9cf5c7718 [project @ 2007-03-05 22:03:31 by dbateman]
dbateman
parents: 6375
diff changeset
35 #include "load-path.h"
65e9cf5c7718 [project @ 2007-03-05 22:03:31 by dbateman]
dbateman
parents: 6375
diff changeset
36 #include "oct-env.h"
6375
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
37 #include "oct-md5.h"
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
38
6383
65e9cf5c7718 [project @ 2007-03-05 22:03:31 by dbateman]
dbateman
parents: 6375
diff changeset
39 DEFUN_DLD (md5sum, args, ,
6375
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
40 "-*- texinfo -*-\n\
6383
65e9cf5c7718 [project @ 2007-03-05 22:03:31 by dbateman]
dbateman
parents: 6375
diff changeset
41 @deftypefn {Loadable Function} {} md5sum (@var{file})\n\
65e9cf5c7718 [project @ 2007-03-05 22:03:31 by dbateman]
dbateman
parents: 6375
diff changeset
42 @deftypefnx {Loadable Function} {} md5sum (@var{str}, @var{opt})\n\
9064
7c02ec148a3c Check grammar on all .cc files
Rik <rdrider0-list@yahoo.com>
parents: 7016
diff changeset
43 Calculates the MD5 sum of the file @var{file}. If the second parameter\n\
6383
65e9cf5c7718 [project @ 2007-03-05 22:03:31 by dbateman]
dbateman
parents: 6375
diff changeset
44 @var{opt} exists and is true, then calculate the MD5 sum of the\n\
65e9cf5c7718 [project @ 2007-03-05 22:03:31 by dbateman]
dbateman
parents: 6375
diff changeset
45 string @var{str}.\n\
6375
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
46 @end deftypefn")
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
47 {
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
48 octave_value retval;
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
49 int nargin = args.length ();
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
50
6383
65e9cf5c7718 [project @ 2007-03-05 22:03:31 by dbateman]
dbateman
parents: 6375
diff changeset
51 if (nargin != 1 && nargin != 2)
6375
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
52 print_usage();
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
53 else
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
54 {
6383
65e9cf5c7718 [project @ 2007-03-05 22:03:31 by dbateman]
dbateman
parents: 6375
diff changeset
55 bool have_str = false;
6375
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
56 std::string str = args(0).string_value();
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
57
6383
65e9cf5c7718 [project @ 2007-03-05 22:03:31 by dbateman]
dbateman
parents: 6375
diff changeset
58 if (nargin == 2)
65e9cf5c7718 [project @ 2007-03-05 22:03:31 by dbateman]
dbateman
parents: 6375
diff changeset
59 have_str = args(1).bool_value();
65e9cf5c7718 [project @ 2007-03-05 22:03:31 by dbateman]
dbateman
parents: 6375
diff changeset
60
6375
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
61 if (!error_state)
6383
65e9cf5c7718 [project @ 2007-03-05 22:03:31 by dbateman]
dbateman
parents: 6375
diff changeset
62 {
65e9cf5c7718 [project @ 2007-03-05 22:03:31 by dbateman]
dbateman
parents: 6375
diff changeset
63 if (have_str)
65e9cf5c7718 [project @ 2007-03-05 22:03:31 by dbateman]
dbateman
parents: 6375
diff changeset
64 retval = oct_md5 (str);
65e9cf5c7718 [project @ 2007-03-05 22:03:31 by dbateman]
dbateman
parents: 6375
diff changeset
65 else
65e9cf5c7718 [project @ 2007-03-05 22:03:31 by dbateman]
dbateman
parents: 6375
diff changeset
66 {
65e9cf5c7718 [project @ 2007-03-05 22:03:31 by dbateman]
dbateman
parents: 6375
diff changeset
67 file_stat fs (str);
65e9cf5c7718 [project @ 2007-03-05 22:03:31 by dbateman]
dbateman
parents: 6375
diff changeset
68
65e9cf5c7718 [project @ 2007-03-05 22:03:31 by dbateman]
dbateman
parents: 6375
diff changeset
69 if (! fs.exists ())
65e9cf5c7718 [project @ 2007-03-05 22:03:31 by dbateman]
dbateman
parents: 6375
diff changeset
70 {
65e9cf5c7718 [project @ 2007-03-05 22:03:31 by dbateman]
dbateman
parents: 6375
diff changeset
71 std::string tmp = octave_env::make_absolute
65e9cf5c7718 [project @ 2007-03-05 22:03:31 by dbateman]
dbateman
parents: 6375
diff changeset
72 (load_path::find_file (str), octave_env::getcwd ());
65e9cf5c7718 [project @ 2007-03-05 22:03:31 by dbateman]
dbateman
parents: 6375
diff changeset
73
65e9cf5c7718 [project @ 2007-03-05 22:03:31 by dbateman]
dbateman
parents: 6375
diff changeset
74 if (! tmp.empty ())
65e9cf5c7718 [project @ 2007-03-05 22:03:31 by dbateman]
dbateman
parents: 6375
diff changeset
75 {
65e9cf5c7718 [project @ 2007-03-05 22:03:31 by dbateman]
dbateman
parents: 6375
diff changeset
76 warning_with_id ("Octave:md5sum-file-in-path",
65e9cf5c7718 [project @ 2007-03-05 22:03:31 by dbateman]
dbateman
parents: 6375
diff changeset
77 "md5sum: file found in load path");
65e9cf5c7718 [project @ 2007-03-05 22:03:31 by dbateman]
dbateman
parents: 6375
diff changeset
78 str = tmp;
65e9cf5c7718 [project @ 2007-03-05 22:03:31 by dbateman]
dbateman
parents: 6375
diff changeset
79 }
65e9cf5c7718 [project @ 2007-03-05 22:03:31 by dbateman]
dbateman
parents: 6375
diff changeset
80 }
65e9cf5c7718 [project @ 2007-03-05 22:03:31 by dbateman]
dbateman
parents: 6375
diff changeset
81
65e9cf5c7718 [project @ 2007-03-05 22:03:31 by dbateman]
dbateman
parents: 6375
diff changeset
82 retval = oct_md5_file (str);
65e9cf5c7718 [project @ 2007-03-05 22:03:31 by dbateman]
dbateman
parents: 6375
diff changeset
83 }
65e9cf5c7718 [project @ 2007-03-05 22:03:31 by dbateman]
dbateman
parents: 6375
diff changeset
84 }
6375
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
85 }
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
86
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
87 return retval;
5fced7a5eee8 [project @ 2007-03-01 17:23:39 by dbateman]
dbateman
parents:
diff changeset
88 }