File: javaaddpath.m

package info (click to toggle)
octave 10.3.0-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 145,388 kB
  • sloc: cpp: 335,976; ansic: 82,241; fortran: 20,963; objc: 9,402; sh: 8,756; yacc: 4,392; lex: 4,333; perl: 1,544; java: 1,366; awk: 1,259; makefile: 660; xml: 192
file content (184 lines) | stat: -rw-r--r-- 6,067 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
########################################################################
##
## Copyright (C) 2007-2025 The Octave Project Developers
##
## See the file COPYRIGHT.md in the top-level directory of this
## distribution or <https://octave.org/copyright/>.
##
## 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
## <https://www.gnu.org/licenses/>.
##
########################################################################

## -*- texinfo -*-
## @deftypefn  {} {} javaaddpath (@var{clspath})
## @deftypefnx {} {} javaaddpath (@var{clspath1}, @dots{})
## @deftypefnx {} {} javaaddpath (@{@var{clspath1}, @dots{}@})
## @deftypefnx {} {} javaaddpath (@dots{}, "-end")
## Add @var{clspath} to the beginning of the dynamic class path of the
## Java virtual machine.
##
## @var{clspath} may either be a directory where @file{.class} files are
## found, or a @file{.jar} file containing Java classes.  Multiple paths may
## be added at once by specifying additional arguments, or by using a cell
## array of strings.
##
## If the final argument is @qcode{"-end"}, append the new element to the
## end of the current classpath.
##
## @seealso{javarmpath, javaclasspath}
## @end deftypefn

function javaaddpath (varargin)

  if (nargin < 1)
    print_usage ();
  endif

  if (! all (cellfun (@(c) ischar (c) || iscellstr (c), varargin)))
    error ("javaaddpath: arguments must be strings or cell array of strings");
  endif

  if (strcmp (varargin{end}, "-end"))
    at_end = true;
    varargin(end) = [];
  else
    ## Note that when prepending, we iterate over the arguments in
    ## reverse so that a call like
    ##
    ##   javaaddpath ("/foo", "/bar")
    ##
    ## results in "/foo" first in the path followed by "/bar".
    at_end = false;
    varargin = fliplr (varargin);
  endif

  for arg = varargin
    if (iscellstr (arg{1}))
      if (at_end)
        ## Guarantee cellstr array is a row vector
        arg = arg{1}(:).';
      else
        ## Iterate in reverse over cell arrays
        arg = fliplr (arg{1}(:).');
      endif
    endif

    for clspath = arg
      clspath = clspath{1};

      new_path = canonicalize_file_name (tilde_expand (clspath));
      if (isfolder (new_path))
        if (new_path(end) != filesep ())
          new_path = [new_path, filesep()];
        endif
      elseif (! exist (new_path, "file"))
        error ("javaaddpath: CLSPATH does not exist: %s", clspath);
      endif

      success = javaMethod ("addClassPath", "org.octave.ClassHelper",
                            new_path, at_end);

      if (! success)
        warning ("javaaddpath: failed to add '%s' to Java classpath", new_path);
      endif
    endfor
  endfor

endfunction


## FIXME: These tests may fail if either TEMPDIR or HOME have already
##        been added to the Java class path.

## Basic prepend test with single string
%!testif HAVE_JAVA; usejava ("jvm")
%! pth = tempdir ();
%! unwind_protect
%!   clspth1 = javaclasspath ("-dynamic");
%!   javaaddpath (pth);
%!   clspth2 = javaclasspath ("-dynamic");
%!   assert (clspth2{1}, canonicalize_file_name (pth));
%!   assert (clspth2(2:end), clspth1(1:end));
%! unwind_protect_cleanup
%!   javarmpath (pth);
%! end_unwind_protect

## Prepend test with two strings
%!testif HAVE_JAVA; usejava ("jvm")
%! pth1 = tempdir ();
%! pth2 = tilde_expand ("~");
%! unwind_protect
%!   clspth1 = javaclasspath ("-dynamic");
%!   javaaddpath (pth1, pth2);
%!   clspth2 = javaclasspath ("-dynamic");
%!   assert (clspth2([1, 2]),
%!           {canonicalize_file_name(pth1), canonicalize_file_name(pth2)});
%!   assert (clspth2(3:end), clspth1(1:end));
%! unwind_protect_cleanup
%!   javarmpath (pth1, pth2);
%! end_unwind_protect

## Prepend test with cell array of two strings
%!testif HAVE_JAVA; usejava ("jvm")
%! pth1 = tempdir ();
%! pth2 = tilde_expand ("~");
%! unwind_protect
%!   clspth1 = javaclasspath ("-dynamic");
%!   javaaddpath ({pth1, pth2});
%!   clspth2 = javaclasspath ("-dynamic");
%!   assert (clspth2([1, 2]),
%!           {canonicalize_file_name(pth1), canonicalize_file_name(pth2)});
%!   assert (clspth2(3:end), clspth1(1:end));
%! unwind_protect_cleanup
%!   javarmpath (pth1, pth2);
%! end_unwind_protect

## Append test with two strings
%!testif HAVE_JAVA; usejava ("jvm")
%! pth1 = tempdir ();
%! pth2 = tilde_expand ("~");
%! unwind_protect
%!   clspth1 = javaclasspath ("-dynamic");
%!   javaaddpath (pth1, pth2, "-end");
%!   clspth2 = javaclasspath ("-dynamic");
%!   assert (clspth2([end-1, end]),
%!           {canonicalize_file_name(pth1), canonicalize_file_name(pth2)});
%!   assert (clspth2(1:end-2), clspth1(1:end));
%! unwind_protect_cleanup
%!   javarmpath (pth1, pth2);
%! end_unwind_protect

## Append test with cell array of two strings
%!testif HAVE_JAVA; usejava ("jvm")
%! pth1 = tempdir ();
%! pth2 = tilde_expand ("~");
%! unwind_protect
%!   clspth1 = javaclasspath ("-dynamic");
%!   javaaddpath ({pth1, pth2}, "-end");
%!   clspth2 = javaclasspath ("-dynamic");
%!   assert (clspth2([end-1, end]),
%!           {canonicalize_file_name(pth1), canonicalize_file_name(pth2)});
%!   assert (clspth2(1:end-2), clspth1(1:end));
%! unwind_protect_cleanup
%!   javarmpath (pth1, pth2);
%! end_unwind_protect

## Test input validation
%!error <Invalid call> javaaddpath ()
%!error <arguments must be strings> javaaddpath (5)
%!error <arguments must be .* cell array of strings> javaaddpath ({5})
%!error <CLSPATH does not exist> javaaddpath ("%_A_Very_Unlikely_Name_%")