Coverage Report

Coverage Report - eu.simuline.octave.OctaveUtils

Classes in this File

Line Coverage

Branch Coverage

Complexity

OctaveUtils

90%

20/22

90%

9/10

2.2

 package eu.simuline.octave;
 
 import java.util.Collection;
 import java.util.HashSet;
 import java.util.Random;
 
 import java.util.regex.Pattern;
 
 import java.nio.charset.Charset;
 
 import eu.simuline.octave.type.OctaveCell;
 import eu.simuline.octave.type.OctaveString;
 
 /**
  * Small utility functions that can be used with JavaOctave.
  * 
  * Holder class for static functions.
  */
 public final class OctaveUtils {
 
     /**
      * A variable name not to be listed by {@link #listVars(OctaveEngine)}. 
      */
     private static final String NARGIN = "__nargin__";
 
     /**
      * A variable name not to be listed by {@link #listVars(OctaveEngine)}. 
      */
     private static final String ANS    = "ans";
 
     private static final Random RANDOM = new Random();
 
     private OctaveUtils() {
         throw new UnsupportedOperationException("Do not instantiate");
     }
 
 
     /**
      * Returns the charset UTF-8 used throughout. 
      */
     public static Charset getUTF8() {
         return Charset.forName("UTF-8");
     }
 
     /**
      * @param octave
      * @return list of variables
      */
     @edu.umd.cs.findbugs.annotations.SuppressWarnings
     (value = "VA_FORMAT_STRING_USES_NEWLINE", 
      justification = "Format string evaluates in octave independent of os. ")
     public static Collection<String> listVars(final OctaveEngine octave) {
         final String varName = randomVarName();
         String evalStr = // %1 is varName 
             "%1$s = cell(0, 1);\n" + 
             "if strncmp(OCTAVE_VERSION(), \"3.0.\", 4)\n" + 
             "  %1$s_1 = whos -v;\n" + // version 3.0
             "else\n" + 
             "  %1$s_1 = whos;\n" + // version 3.2 (and other)
             "endif\n" + 
             "for %1$s_2 = 1 : numel(%1$s_1)\n" + 
             "  %1$s{%1$s_2} = %1$s_1(%1$s_2).name;\n" + 
             "endfor\n" + 
             "clear %1$s_1 %1$s_2\n";
         octave.eval(String.format(evalStr, varName));
         final OctaveCell data = octave.get(OctaveCell.class, varName);
         octave.eval("clear " + varName);
         final Collection<String> collection = new HashSet<String>();
         final Pattern pattern = Pattern.compile("javaoctave_[0-9a-f]{12}_eval");
         for (int i = 1; i <= data.getSize(2); ++i) {
             final String name = data.get(OctaveString.class, 1, i).getString();
             if (varName.equals(name) || 
                 NARGIN .equals(name) || 
                 ANS    .equals(name) || 
                 pattern.matcher(name).matches()) {
                 continue;
             }
             collection.add(name);
         }
         return collection;
     }
 
     @SuppressWarnings("checkstyle:magicnumber")
     // 30 is some number, compromize between security and performance 
     private static synchronized int nextInt() {
         return RANDOM.nextInt(1 << 30);
     }
 
 
     /**
      * Returns a variable with value not accessible. 
      *
      * @return a <code>String</code> value
      */
     private static String randomVarName() {
         return String.format("_OctaveUtils_%d", nextInt());
     }
 
 }

1		package eu.simuline.octave;
2
3		import java.util.Collection;
4		import java.util.HashSet;
5		import java.util.Random;
6
7		import java.util.regex.Pattern;
8
9		import java.nio.charset.Charset;
10
11		import eu.simuline.octave.type.OctaveCell;
12		import eu.simuline.octave.type.OctaveString;
13
14		/**
15		* Small utility functions that can be used with JavaOctave.
16		*
17		* Holder class for static functions.
18		*/
19		public final class OctaveUtils {
20
21		/**
22		* A variable name not to be listed by {@link #listVars(OctaveEngine)}.
23		*/
24		private static final String NARGIN = "__nargin__";
25
26		/**
27		* A variable name not to be listed by {@link #listVars(OctaveEngine)}.
28		*/
29		private static final String ANS = "ans";
30
31	2	private static final Random RANDOM = new Random();
32
33	0	private OctaveUtils() {
34	0	throw new UnsupportedOperationException("Do not instantiate");
35		}
36
37
38		/**
39		* Returns the charset UTF-8 used throughout.
40		*/
41		public static Charset getUTF8() {
42	528	return Charset.forName("UTF-8");
43		}
44
45		/**
46		* @param octave
47		* @return list of variables
48		*/
49		@edu.umd.cs.findbugs.annotations.SuppressWarnings
50		(value = "VA_FORMAT_STRING_USES_NEWLINE",
51		justification = "Format string evaluates in octave independent of os. ")
52		public static Collection<String> listVars(final OctaveEngine octave) {
53	6	final String varName = randomVarName();
54	6	String evalStr = // %1 is varName
55		"%1$s = cell(0, 1);\n" +
56		"if strncmp(OCTAVE_VERSION(), \"3.0.\", 4)\n" +
57		" %1$s_1 = whos -v;\n" + // version 3.0
58		"else\n" +
59		" %1$s_1 = whos;\n" + // version 3.2 (and other)
60		"endif\n" +
61		"for %1$s_2 = 1 : numel(%1$s_1)\n" +
62		" %1$s{%1$s_2} = %1$s_1(%1$s_2).name;\n" +
63		"endfor\n" +
64		"clear %1$s_1 %1$s_2\n";
65	6	octave.eval(String.format(evalStr, varName));
66	6	final OctaveCell data = octave.get(OctaveCell.class, varName);
67	6	octave.eval("clear " + varName);
68	6	final Collection<String> collection = new HashSet<String>();
69	6	final Pattern pattern = Pattern.compile("javaoctave_[0-9a-f]{12}_eval");
70	26	for (int i = 1; i <= data.getSize(2); ++i) {
71	20	final String name = data.get(OctaveString.class, 1, i).getString();
72	20	if (varName.equals(name) \|\|
73	14	NARGIN .equals(name) \|\|
74	14	ANS .equals(name) \|\|
75	12	pattern.matcher(name).matches()) {
76	6	continue;
77		}
78	6	collection.add(name);
79		}
80	6	return collection;
81		}
82
83		@SuppressWarnings("checkstyle:magicnumber")
84		// 30 is some number, compromize between security and performance
85		private static synchronized int nextInt() {
86	6	return RANDOM.nextInt(1 << 30);
87		}
88
89
90		/**
91		* Returns a variable with value not accessible.
92		*
93		* @return a <code>String</code> value
94		*/
95		private static String randomVarName() {
96	6	return String.format("_OctaveUtils_%d", nextInt());
97		}
98
99		}