diff scripts/pkg/private/get_description.m @ 14466:cfb0173fe1ca

maint: Refactor pkg.m and move subfunctions to private/ directory. * pkg.m: move all sub-functions to private/ * pkg/private/absolute_pathname.m * pkg/private/build.m * pkg/private/configure_make.m * pkg/private/copy_files.m * pkg/private/create_pkgadddel.m * pkg/private/describe.m * pkg/private/dirempty.m * pkg/private/extract_pkg.m * pkg/private/finish_installation.m * pkg/private/fix_depends.m * pkg/private/fix_version.m * pkg/private/generate_lookfor_cache.m * pkg/private/get_description.m * pkg/private/get_forge_download.m * pkg/private/get_forge_pkg.m * pkg/private/getarch.m * pkg/private/getarchdir.m * pkg/private/getarchprefix.m * pkg/private/get_unsatisfied_deps.m * pkg/private/install.m * pkg/private/installed_packages.m * pkg/private/is_architecture_dependent.m * pkg/private/isautoload.m * pkg/private/issuperuser.m * pkg/private/list_forge_packages.m * pkg/private/load_package_dirs.m * pkg/private/load_packages.m * pkg/private/load_packages_and_dependencies.m * pkg/private/packinfo_copy_file.m * pkg/private/parse_pkg_idx.m * pkg/private/prepare_installation.m * pkg/private/print_package_description.m * pkg/private/rebuild.m * pkg/private/repackage.m * pkg/private/rm_rf.m * pkg/private/rstrip.m * pkg/private/save_order.m * pkg/private/shell.m * pkg/private/split_by.m * pkg/private/strip.m * pkg/private/uninstall.m * pkg/private/unload_packages.m * pkg/private/verify_directory.m * pkg/private/write_index.m
author Carlo de Falco <kingcrimson@tiscali.it>
date Thu, 15 Mar 2012 19:41:24 +0100
parents
children ec7ab7e37731
line wrap: on
line diff
new file mode 100644
--- /dev/null
+++ b/scripts/pkg/private/get_description.m
@@ -0,0 +1,80 @@
+## Copyright (C) 2005-2012 S�ren Hauberg
+## Copyright (C) 2010 VZLU Prague, a.s.
+##
+## This file is part of Octave.
+##
+## Octave is free software; you can redistribute it and/or modify it
+## under the terms of the GNU General Public License as published by
+## the Free Software Foundation; either version 3 of the License, or (at
+## your option) any later version.
+##
+## Octave is distributed in the hope that it will be useful, but
+## WITHOUT ANY WARRANTY; without even the implied warranty of
+## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+## General Public License for more details.
+##
+## You should have received a copy of the GNU General Public License
+## along with Octave; see the file COPYING.  If not, see
+## <http://www.gnu.org/licenses/>.
+
+## -*- texinfo -*-
+## @deftypefn  {Function File} {@var{desc} =} get_description (@var{filename})
+## Undocumented internal function.
+## @end deftypefn
+
+## Parse the DESCRIPTION file.
+function desc = get_description (filename)
+  [fid, msg] = fopen (filename, "r");
+  if (fid == -1)
+    error ("the DESCRIPTION file %s could not be read: %s", filename, msg);
+  endif
+
+  desc = struct ();
+
+  line = fgetl (fid);
+  while (line != -1)
+    if (line(1) == "#")
+      ## Comments, do nothing.
+    elseif (isspace(line(1)))
+      ## Continuation lines
+      if (exist ("keyword", "var") && isfield (desc, keyword))
+        desc.(keyword) = cstrcat (desc.(keyword), " ", rstrip(line));
+      endif
+    else
+      ## Keyword/value pair
+      colon = find (line == ":");
+      if (length (colon) == 0)
+        disp ("skipping line");
+      else
+        colon = colon(1);
+        keyword = tolower (strip (line(1:colon-1)));
+        value = strip (line (colon+1:end));
+        if (length (value) == 0)
+            fclose (fid);
+            error ("The keyword `%s' of the package `%s' has an empty value",
+                    keyword, desc.name);
+        endif
+        desc.(keyword) = value;
+      endif
+    endif
+    line = fgetl (fid);
+  endwhile
+  fclose (fid);
+
+  ## Make sure all is okay.
+  needed_fields = {"name", "version", "date", "title", ...
+                   "author", "maintainer", "description"};
+  for f = needed_fields
+    if (! isfield (desc, f{1}))
+      error ("description is missing needed field %s", f{1});
+    endif
+  endfor
+  desc.version = fix_version (desc.version);
+  if (isfield (desc, "depends"))
+    desc.depends = fix_depends (desc.depends);
+  else
+    desc.depends = "";
+  endif
+  desc.name = tolower (desc.name);
+endfunction
+