[Plplot-cvs] SF.net SVN: plplot:[13086] trunk/bindings/octave/PLplot/support

[<ai...@us...>]

Revision: 13086
          http://sourceforge.net/p/plplot/code/13086
Author:   airwin
Date:     2014-03-27 01:12:32 +0000 (Thu, 27 Mar 2014)
Log Message:
-----------
Add patched version of system __makeinfo__.m which uses the "schar"
(signed character) type to write a documentation string to a temporary
file.  This fixes an Octave issue 
<http://savannah.gnu.org/bugs/index.php?41965> with the default
"uchar" type for fwrite used by the system version of __makeinfo__.m.
The result of that default type is all utf8 8-bit binary characters
are replaced by nulls (which therefore truncates the output from
the help command when the help string contains utf8 characters).  This truncation is eliminated
by this patched version of __makeinfo__.m, but this file should be
withdrawn again once octave fixes bug 41965 and that fix propagates
to most octave installations.

Tested on Linux with octave 3.6.2 by changing directory to the top of
the build tree, setting the octavedir environment
variable

export
octavedir=bindings/octave:../plplot_allura/bindings/octave/PLplot:../plplot_allura/bindings/octave/PLplot/support/:../plplot_allura/bindings/octave/misc/:

, and then executing the following octave
commands inside an octave session:

addpath(getenv("octavedir"));
plplot_stub;
help plot3dcl;

The latter command gave the full expected utf8 help for plplot3dl without
truncation.

Modified Paths:
--------------
    trunk/bindings/octave/PLplot/support/CMakeLists.txt

Added Paths:
-----------
    trunk/bindings/octave/PLplot/support/__makeinfo__.m

Modified: trunk/bindings/octave/PLplot/support/CMakeLists.txt
===================================================================
--- trunk/bindings/octave/PLplot/support/CMakeLists.txt	2014-03-27 00:24:08 UTC (rev 13085)
+++ trunk/bindings/octave/PLplot/support/CMakeLists.txt	2014-03-27 01:12:32 UTC (rev 13086)
@@ -50,6 +50,7 @@
 __plt__.m
 is_strmatrix.m
 is_strvector.m
+__makeinfo__.m
 )
 
 install(FILES ${m_files} DESTINATION ${PLPLOT_OCTAVE_DIR}/support)

Added: trunk/bindings/octave/PLplot/support/__makeinfo__.m
===================================================================
--- trunk/bindings/octave/PLplot/support/__makeinfo__.m	                        (rev 0)
+++ trunk/bindings/octave/PLplot/support/__makeinfo__.m	2014-03-27 01:12:32 UTC (rev 13086)
@@ -0,0 +1,150 @@
+## Copyright (C) 2009-2012 S�ren Hauberg
+##
+## 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{retval}, @var{status}] =} __makeinfo__ (@var{text}, @var{output_type})
+## @deftypefnx {Function File} {[@var{retval}, @var{status}] =} __makeinfo__ (@var{text}, @var{output_type}, @var{see_also})
+## Undocumented internal function.
+## @end deftypefn
+
+## Run @code{makeinfo} on a given text.
+##
+## The string @var{text} is run through the @code{__makeinfo__} program
+## to generate output in various formats. This string must contain valid
+## Texinfo formatted text.
+##
+## The @var{output_type} selects the format of the output. This can be either
+## @t{"html"}, @t{"texinfo"}, or @t{"plain text"}. By default this is
+## @t{"plain text"}. If @var{output_type} is @t{"texinfo"}, the @t{@@seealso}
+## macro is expanded, but otherwise the text is unaltered.
+##
+## If the optional argument @var{see_also} is present, it is used to expand the
+## Octave specific @t{@@seealso} macro. This argument must be a function handle,
+## that accepts a cell array of strings as input argument (each elements of the
+## array corresponds to the arguments to the @t{@@seealso} macro), and return
+## the expanded string. If this argument is not given, the @t{@@seealso} macro
+## will be expanded to the text
+##
+## @example
+## See also: arg1, arg2, ...
+## @end example
+##
+## @noindent
+## for @t{"plain text"} output, and
+##
+## @example
+## See also: @@ref@{arg1@}, @@ref@{arg2@}, ...
+## @end example
+##
+## @noindent
+## otherwise.
+##
+## The optional output argument @var{status} contains the exit status of the
+## @code{makeinfo} program as returned by @code{system}.
+
+function [retval, status] = __makeinfo__ (text, output_type = "plain text", fsee_also)
+
+  ## Check input
+  if (nargin < 1 || nargin > 3)
+    print_usage ();
+  endif
+
+  if (! ischar (text))
+    error ("__makeinfo__: first input argument must be a string");
+  endif
+
+  if (! ischar (output_type))
+    error ("__makeinfo__: second input argument must be a string");
+  endif
+
+  if (nargin < 3)
+    if (strcmpi (output_type, "plain text"))
+      fsee_also = @(T) strcat ...
+          ("\nSee also:", sprintf (" %s,", T{:})(1:end-1), "\n");
+    else
+      fsee_also = @(T) strcat ...
+          ("\nSee also:", sprintf (" @ref{%s},", T{:})(1:end-1), "\n");
+    endif
+  endif
+
+  if (! isa (fsee_also, "function_handle"))
+    error ("__makeinfo__: third input argument must be a function handle");
+  endif
+
+
+  ## It seems like makeinfo sometimes gets angry if the first character
+  ## on a line is a space, so we remove these.
+  text = strrep (text, "\n ", "\n");
+
+  ## Handle @seealso macro
+  see_also_pat = '@seealso *\{(.*)\}';
+  args = regexp (text, see_also_pat, 'tokens');
+  for ii = 1:numel (args)
+    expanded = fsee_also (strtrim (strsplit (args{ii}{:}, ',', true)));
+    text = regexprep (text, see_also_pat, expanded, 'once');
+  endfor
+
+  ## Handle @nospell macro
+  text = regexprep (text, '@nospell *\{([^}]*)\}', "$1");
+  ## Handle @xcode macro
+  text = regexprep (text, '@xcode *\{([^}]*)\}', "$1");
+
+  if (strcmpi (output_type, "texinfo"))
+    status = 0;
+    retval = text;
+    return;
+  endif
+
+  ## Create the final TeXinfo input string
+  text = sprintf ("\\input texinfo\n\n%s\n\n@bye\n", text);
+
+  unwind_protect
+    ## Write Texinfo to tmp file
+    template = "octave-help-XXXXXX";
+    [fid, name] = mkstemp (fullfile (P_tmpdir, template), true);
+    if (fid < 0)
+      error ("__makeinfo__: could not create temporary file");
+    endif
+    fwrite (fid, text, "schar");
+    fclose (fid);
+
+    ## Take action depending on output type
+    switch (lower (output_type))
+      case "plain text"
+        cmd = sprintf ("%s --no-headers --no-warn --force --no-validate %s",
+                       makeinfo_program (), name);
+      case "html"
+        cmd = sprintf ("%s --no-headers --html --no-warn --no-validate --force %s",
+                       makeinfo_program (), name);
+      otherwise
+        error ("__makeinfo__: unsupported output type: '%s'", output_type);
+    endswitch
+
+    ## Call makeinfo
+    [status, retval] = system (cmd);
+
+  unwind_protect_cleanup
+    if (exist (name, "file"))
+      delete (name);
+    endif
+  end_unwind_protect
+endfunction
+
+## No test needed for internal helper function.
+%!assert (1)
+


Property changes on: trunk/bindings/octave/PLplot/support/__makeinfo__.m
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.