<xsl:value-of select="$title"/>

Index: /trunk/org.etsi.common/.classpath =================================================================== --- /trunk/org.etsi.common/.classpath (revision 7) +++ /trunk/org.etsi.common/.classpath (revision 7) @@ -0,0 +1,8 @@ + + + + + + + + Index: /trunk/org.etsi.common/.project =================================================================== --- /trunk/org.etsi.common/.project (revision 7) +++ /trunk/org.etsi.common/.project (revision 7) @@ -0,0 +1,17 @@ + + + org.etsi.common + + + + + + org.eclipse.jdt.core.javabuilder + + + + + + org.eclipse.jdt.core.javanature + + Index: /trunk/org.etsi.common/build.xml =================================================================== --- /trunk/org.etsi.common/build.xml (revision 7) +++ /trunk/org.etsi.common/build.xml (revision 7) @@ -0,0 +1,39 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + Building ETSI MiscTools Distribution in ${dist}... + + + + + + + + + + + + + Index: /trunk/org.etsi.common/lib/LICENSE.txt =================================================================== --- /trunk/org.etsi.common/lib/LICENSE.txt (revision 7) +++ /trunk/org.etsi.common/lib/LICENSE.txt (revision 7) @@ -0,0 +1,202 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + Index: /trunk/org.etsi.common/lib/xstream-license.txt =================================================================== --- /trunk/org.etsi.common/lib/xstream-license.txt (revision 7) +++ /trunk/org.etsi.common/lib/xstream-license.txt (revision 7) @@ -0,0 +1,28 @@ +(BSD Style License) + +Copyright (c) 2003-2006, Joe Walnes +Copyright (c) 2006-2007, XStream Committers +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +Redistributions of source code must retain the above copyright notice, this list of +conditions and the following disclaimer. Redistributions in binary form must reproduce +the above copyright notice, this list of conditions and the following disclaimer in +the documentation and/or other materials provided with the distribution. + +Neither the name of XStream nor the names of its contributors may be used to endorse +or promote products derived from this software without specific prior written +permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY +EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT +SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, +INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED +TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR +BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY +WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH +DAMAGE. Index: /trunk/org.etsi.common/src/org/etsi/common/ExtensionFilter.java =================================================================== --- /trunk/org.etsi.common/src/org/etsi/common/ExtensionFilter.java (revision 7) +++ /trunk/org.etsi.common/src/org/etsi/common/ExtensionFilter.java (revision 7) @@ -0,0 +1,45 @@ +package org.etsi.common; + +import java.io.File; +import java.io.FileFilter; +import java.util.regex.Matcher; +import java.util.regex.Pattern; + +public class ExtensionFilter implements FileFilter { + + private String extRegExp = ""; + + public ExtensionFilter(String extRegExp) { + this.extRegExp = extRegExp; + } + + public static String getFileExtension(String filename) { + String ext = ""; + new File(filename); + int i = filename.lastIndexOf('.'); + if (i > 0 && i < filename.length() - 1) { + ext = filename.substring(i + 1).toLowerCase(); + } + return ext; + } + + public static boolean checkFileExtension(File file, String regExp){ + Pattern extPattern = Pattern.compile(regExp); + Matcher extMatcher = extPattern.matcher(getFileExtension(file.getName())); + if (extMatcher.matches()) { + return true; + } + + return false; + } + + public boolean accept(File filename) { + if (filename.isFile()) { + if (checkFileExtension(filename, this.extRegExp)) { + return true; + } + } + return false; + } + +} Index: /trunk/org.etsi.common/src/org/etsi/common/InputInterface.java =================================================================== --- /trunk/org.etsi.common/src/org/etsi/common/InputInterface.java (revision 7) +++ /trunk/org.etsi.common/src/org/etsi/common/InputInterface.java (revision 7) @@ -0,0 +1,186 @@ +package org.etsi.common; + +import java.io.File; +import java.io.FileFilter; +import java.io.IOException; +import java.util.LinkedList; +import java.util.List; + +public class InputInterface { + //TODO: can be transformed to static + + private String projectExt = "t3p"; + private String extRegExp = "ttcn|ttcn3"; + private boolean recursive = true; + + public InputInterface(String resourceExtRegExp, boolean recursive){ + this.extRegExp = resourceExtRegExp; + this.recursive = recursive; + } + + + public InputInterface(String resourceExtRegExp, String projectExt, boolean recursive){ + this.extRegExp = resourceExtRegExp; + this.projectExt = projectExt; + this.recursive = recursive; + } + + public void setExtRegExp(String extRegExp) { + this.extRegExp = extRegExp; + } + + public String getExtRegExp() { + return extRegExp; + } + + public void setRecursive(boolean recursive) { + this.recursive = recursive; + } + + public boolean isRecursive() { + return recursive; + } + + public List inputFromFile(String filename){ + List files = new LinkedList(); + File file = new File(filename); + if (file.isFile() && ExtensionFilter.checkFileExtension(file, extRegExp)){ + files.add(file.getPath()); + } + return files; + } + + public List inputFromDirectory(String directory){ + List files = new LinkedList(); + File inputDir = new File(directory); + File[] fileList = inputDir.listFiles(new ExtensionFilter(this.getExtRegExp())); + + for (int i = 0; i < fileList.length; i++) { + files.add(fileList[i].getPath()); + } + + File[] dirList = inputDir.listFiles(new FileFilter() { + public boolean accept(File pathname) { + if (pathname.isDirectory()) + return true; + return false; + } + }); + + if (this.isRecursive()){ + for (int i = 0; i < dirList.length; i++) { + files.addAll(inputFromDirectory(dirList[i].getPath())); + } + } + + return files; + } + + public List inputFromWildcard(String wildcard){ + List files = new LinkedList(); + File wildcardFile = new File(wildcard); + System.out.println("Expanding wildcard \""+wildcard+"\"..."); + File wildcardParentFile = wildcardFile.getParentFile(); + if (wildcardParentFile == null) { + wildcardParentFile = new File("."); + } + //TODO: needs to check if it is null and handle the situation + if (wildcardParentFile.isDirectory()){ + File[] fileList = wildcardParentFile.listFiles(new WildcardFilter(wildcardFile)); + for (int i = 0; i < fileList.length; i++) { + System.out.println(" ->"+fileList[i].getPath()); + files.addAll(this.getInputFromParameter(fileList[i].getPath())); + } + } else { + //invalid parent directory, return + } + if (files.isEmpty()) { + System.out.println(" ->No files found!"); + } + return files; + } + + public List inputFromProject(String projectFilename){ + List files = new LinkedList(); + System.out.println("Reading input files from project file \""+projectFilename+"\"..."); + //TODO: Fill with content + String projectFile = MiscTools.readFile(projectFilename); + String[] lines = projectFile.split("\n"); + for (String line : lines) { + if (!line.matches("\\s*")) {//.equals("")) { + System.out.println(" "+line); + files.addAll(this.getInputFromParameter(line)); + } + } + return files; + } + + public void addToProject(List files, String projectFilename){ + //TODO: Fill with content + } + + //TODO: this will make other duplicate checks obsolete + public static List filterAbsoluteDuplicates(List inputFiles) { + List filteredInputFiles = new LinkedList(); + List absolutePaths = new LinkedList(); + for (String inputFile : inputFiles) { + try { + String canonicalPath = new File(inputFile).getCanonicalPath(); + if (!absolutePaths.contains(canonicalPath)) { + absolutePaths.add(canonicalPath); + filteredInputFiles.add(inputFile); + } + } catch (IOException e) { + // TODO Auto-generated catch block + e.printStackTrace(); + } + } + return filteredInputFiles; + } + + //TODO: review, may be superfluous + public List getInputFromParameterList(List parameters) { + List inputFiles = new LinkedList(); + for (int i = 0; i < parameters.size(); i++) { + List fileList = getInputFromParameter(parameters.get(i)); + for (int f = 0; f < fileList.size(); f++) { + String filename = fileList.get(f); + if (!inputFiles.contains(filename)) { + inputFiles.add(filename); + } else { + System.out.println("Entry \"" + filename + + "\" already present in the list, skipping.."); + } + } + } + return inputFiles; + } + + + public List getInputFromParameter(String inputParameter){ + List inputFiles = new LinkedList(); + File inputParameterFile = new File(inputParameter.trim()); + if (inputParameterFile.isDirectory()){ + if (this.isRecursive()){ + System.out.println("Collecting ttcn3 files recursively in \"" + + inputParameter + "\" ..."); + } else { + System.out.println("Collecting ttcn3 files non-recursively in \"" + + inputParameter + "\" ..."); + } + inputFiles = inputFromDirectory(inputParameter); + } else { + if (inputParameterFile.isFile()){ + if (inputParameterFile.getName().endsWith("."+projectExt)){ + inputFiles = inputFromProject(inputParameter); + } else { + inputFiles = inputFromFile(inputParameter); + } + } else { + inputFiles = inputFromWildcard(inputParameter); + } + } + return inputFiles; + } + +} Index: /trunk/org.etsi.common/src/org/etsi/common/MiscTools.java =================================================================== --- /trunk/org.etsi.common/src/org/etsi/common/MiscTools.java (revision 7) +++ /trunk/org.etsi.common/src/org/etsi/common/MiscTools.java (revision 7) @@ -0,0 +1,182 @@ +package org.etsi.common; + +import java.io.BufferedWriter; + +import java.io.File; +import java.io.FileInputStream; +import java.io.FileNotFoundException; +import java.io.FileOutputStream; +import java.io.IOException; +import java.io.OutputStreamWriter; +import java.io.Writer; +import java.text.DecimalFormat; + +import org.etsi.common.exceptions.TerminationException; + + +public class MiscTools { + + //TODO: Add exceptions and throws declarations + public static String readFile(String filename) { + FileInputStream fis; + String content = ""; + try { + fis = new FileInputStream(filename); + int x = fis.available(); + byte b[] = new byte[x]; + fis.read(b); + content = new String(b); + } catch (FileNotFoundException e) { + String message = "IO ERROR: Filename "+filename+" cannot be found for reading!"; + try { + throw new TerminationException(message); + } catch (TerminationException e1) { + } + } catch (IOException e) { + e.printStackTrace(); + } + + return content; + } + + public static String getShortFilename(String filename) { + String shortfilename = new File(filename).getName(); + return shortfilename; + } + + public static String getMethodName(){ + return Thread.currentThread().getStackTrace()[2].getMethodName(); + } + + + public static void writeFile(String filename, String content) { + FileOutputStream fos; + File targetDir = new File(filename).getAbsoluteFile().getParentFile(); + try { + if (!targetDir.exists()) { + if (!targetDir.mkdirs()) { + System.out + .println("IO ERROR: Creating the directory structure for \"" + + filename + "\" failed!"); + } + } + + try { + fos = new FileOutputStream(filename); + Writer w = new BufferedWriter(new OutputStreamWriter(fos)); + w.write(content); + w.flush(); + w.close(); + + } catch (FileNotFoundException e) { + e.printStackTrace(); + } catch (IOException e) { + e.printStackTrace(); + } + } catch (SecurityException se) { + System.out + .println("IO ERROR: Could not create ouput files and / or directories!" + + "Caused by: \"" + filename + "\""); + } + + } + + public static void streamCopyFile(String sourceFilename, String targetFilename){ + try { + File targetFile = new File(targetFilename); + if (!targetFile.getParentFile().exists()){ + if (!targetFile.getParentFile().mkdirs()){ + System.out + .println("IO ERROR: Creating the directory structure for \"" + + targetFilename + "\" failed!"); + } + } + FileOutputStream outStream = new FileOutputStream(targetFile); + FileInputStream inStream = new FileInputStream(sourceFilename); + int c; + try { + while((c = inStream.read()) != -1){ + outStream.write(c); + } + } catch (IOException e) { + System.out.println("IO ERROR: Caused while copying: \""+sourceFilename+"\" to \""+targetFilename+"\""); + } + } catch (FileNotFoundException e1) { + System.out.println("IO ERROR: File not found: \""+sourceFilename+" / "+targetFilename+"\""); + e1.printStackTrace(); + } + } + +// public static String getSubPath(String basePath, String resourcePath) { +// String subPath = resourcePath.substring(basePath.length()); +// return subPath; +// } + + // -------------------------------------------------------------------------- + + public static int getLOC(String filename){ + int LOC = 0; + String code = MiscTools.readFile(filename); + int index = 0; + while (index != -1) { + if (index == 0){ + index = code.indexOf("\n", index); + } else { + index = code.indexOf("\n", index + 1); + } + LOC++; + } + return LOC; + } + + // -------------------------------------------------------------------------- + public static String doubleToString(double d) { + DecimalFormat fmt = new DecimalFormat("0.00"); + String string = fmt.format(d); + return string; + } + + public static String getSubPath(String inputPath){ + String subPath = ""; + File input = new File(getProperInputPath(inputPath)); + if (input.isFile()){ + subPath = input.getName().substring(0, input.getName().lastIndexOf(".")); + } else { + subPath = input.getName(); + } + return subPath; + } + + public static String getProperOutputPath(String outputDirectory) { + String properOutputPath = ""; + try { + //gets the full path if relative path is provided + properOutputPath = new File(outputDirectory).getCanonicalPath(); + } catch (IOException e) { + System.out.println("IO ERROR: "); + e.printStackTrace(); + } + return properOutputPath; + } + + public static String getProperInputPath(String inputPath) { + // strips slash if present + //TODO: reorganize and extrarct + //TODO: Document "feature" -> if multiple input paths are provided, the first one will be used for the sub path calculation + String properInputPath = new File(inputPath).getPath(); + + if (properInputPath.equals(".")) { + try { + //gets the full path + properInputPath = new File(properInputPath).getCanonicalFile() + .getName(); + } catch (IOException e) { + System.out.println("IO ERROR: "); + e.printStackTrace(); + } + } + return properInputPath; + } + + +} Index: /trunk/org.etsi.common/src/org/etsi/common/WildcardFilter.java =================================================================== --- /trunk/org.etsi.common/src/org/etsi/common/WildcardFilter.java (revision 7) +++ /trunk/org.etsi.common/src/org/etsi/common/WildcardFilter.java (revision 7) @@ -0,0 +1,32 @@ +package org.etsi.common; + +import java.io.File; +import java.io.FileFilter; +import java.util.regex.Matcher; +import java.util.regex.Pattern; + +public class WildcardFilter implements FileFilter { + + private String wildcardRegExp = ""; + + public WildcardFilter(File wildcardFile){ + String wildcardRegExp = wildcardFile.getName(); + wildcardRegExp = wildcardRegExp.replaceAll("\\.", "\\\\."); + wildcardRegExp = wildcardRegExp.replaceAll("\\?", "."); + wildcardRegExp = wildcardRegExp.replaceAll("\\*", ".*"); + this.wildcardRegExp = wildcardRegExp; + } + + @Override + public boolean accept(File file) { + if (file.isFile() || file.isDirectory()){ + Pattern wildcardPattern = Pattern.compile(this.wildcardRegExp); + Matcher wildcardMatcher = wildcardPattern.matcher(file.getName()); + if (wildcardMatcher.matches()) { + return true; + } + } + return false; + } + +} Index: /trunk/org.etsi.common/src/org/etsi/common/configuration/ConfigTools.java =================================================================== --- /trunk/org.etsi.common/src/org/etsi/common/configuration/ConfigTools.java (revision 7) +++ /trunk/org.etsi.common/src/org/etsi/common/configuration/ConfigTools.java (revision 7) @@ -0,0 +1,228 @@ +package org.etsi.common.configuration; + +import java.io.File; +import java.io.FileNotFoundException; +import java.io.FileOutputStream; +import java.io.IOException; +import java.io.OutputStreamWriter; +import java.util.ArrayList; + +import org.etsi.common.MiscTools; +import org.etsi.common.exceptions.TerminationException; + +import com.thoughtworks.xstream.XStream; +import com.thoughtworks.xstream.converters.ConversionException; + +public class ConfigTools { + + private ToolConfiguration config = null; + private String configurationClassName; + private String configurationProfileClassName; + private String toolVersion; + + public ConfigTools(String configurationClassName, String configurationProfileClassName) { + this.configurationClassName = configurationClassName; + this.configurationProfileClassName = configurationProfileClassName; + } + + + public void loadConfig(String configurationFilename) throws TerminationException, InstantiationException, IllegalAccessException, ClassNotFoundException { + System.out.println("Loading configuration ..."); + File configFile = new File(configurationFilename); + if (configFile.exists()) { + config = readConfig(configurationFilename); + if (config == null) { + System.out.println("ERROR: XML configuration could not be loaded! " + + "\n Please check the configuration for consistency or use an auto-generated configuration file to migrate any custom settings!"); + throw new TerminationException(""); + } + } else { + System.out.println("ERROR: Configuration file \""+configurationFilename+"\" does not exist! Use the appropriate option to generate a new default configuration."); + throw new TerminationException(""); +// config = initializeNewDefaultConfig(configurationFilename); + } + } + + public ToolConfiguration initializeNewDefaultConfig( + String configurationFilename) throws TerminationException, InstantiationException, IllegalAccessException, ClassNotFoundException { + System.out.println(" Generating new default configuration in: \"" + + configurationFilename + "\" ..."); + ToolConfiguration config = null; + ConfigurationProfile configurationProfile = null; + config = (ToolConfiguration) Class.forName(configurationClassName).newInstance(); + configurationProfile = (ConfigurationProfile) Class.forName(configurationProfileClassName).newInstance(); + configurationProfile.setProfileName("defaultProfile"); + configurationProfile.setProfileVersion(getToolVersion()); + config.setDefaultConfigurationProfile("all"); + if (config.getConfigurationProfiles() == null) { + ArrayList configurationProfiles = new ArrayList(); + config.setConfigurationProfiles(configurationProfiles); + } + config.getConfigurationProfiles().add(configurationProfile); + writeConfig(config, configurationFilename); + return config; + } + + // ------------------------------------------------------------------------- + +/* //TO BE DEPRECATED + //TODO: Reorganize and reuse + public static String findConfig(String filename) { + File configPath = new File(getConfigurationPath()); + if (configPath.exists()) { + File configFile = null; + if (filename.length() > 0) { + configFile = new File(getConfigurationPath() + filename); + } else { + configFile = new File(getDefaultConfigurationFilePath()); + } + if (configFile.exists()) + return configFile.getAbsolutePath(); + else + return null; + } else { + configPath.mkdir(); + return null; + } + } + //TODO: TO BE DEPRECATED + public static String findConfig() { + return findConfig(""); + } + + + //TODO: TO BE DEPRECATED + //TODO: FIX THESE HARDCODED PARTS + public static String getConfigurationPath() { + if (System.getProperty("os.name").toLowerCase().contains("windows")) { + String appdata = System.getenv("appdata"); + return appdata + "\\T3Q\\"; + } else { // assume unix + String home = System.getProperty("user.home"); + return home + "/.t3q/"; + } + } + + + //TODO: TO BE DEPRECATED + public static String getDefaultConfigurationFilePath() { + return getConfigurationPath() + "t3q.xml"; + } +*/ + // ------------------------------------------------------------------------- + + private ToolConfiguration readConfig(String filename) throws TerminationException { + System.out.println(" Reading XML configuration from: " + filename); + String str = MiscTools.readFile(filename); + XStream xstream = new XStream(); + initXstreamAliases(xstream); + ToolConfiguration config = null; + try{ + config = (ToolConfiguration)xstream.fromXML(str); + } catch (ConversionException ce){ + String line = ""; + line = ce.getMessage().split("line\\snumber[\\t\\s]+?:\\s")[1]; + line = line.substring(0, line.indexOf("\n")); + System.out.println(" Problem Occured while loading configuration: line: "+line); + //TODO: add further debugging details? + } + return config; + } + + private void initXstreamAliases(XStream xstream) throws TerminationException { + try { + xstream.alias(Class.forName(configurationClassName).getSimpleName(), Class.forName(configurationClassName)); + xstream.alias(Class.forName(configurationProfileClassName).getSimpleName(), Class.forName(configurationProfileClassName)); + } catch (ClassNotFoundException e) { + System.out.println(" Problem occurred while initiating XStream. Class not found: "+e.getMessage()); + throw new TerminationException("Class not found: "+e.getMessage()); + } + } + + private void writeConfig(ToolConfiguration config, String filename) throws TerminationException { + System.out.println(" Writing XML configuration to: "+filename); + XStream xstream = new XStream(); + initXstreamAliases(xstream); + String xml = xstream.toXML(config); + OutputStreamWriter oos; + //write out an empty file + MiscTools.writeFile(filename, ""); + try { + oos = new OutputStreamWriter (new FileOutputStream(filename)); + oos.write(xml); + oos.close(); + } catch (FileNotFoundException e) { + System.out.println(" ERROR: File could not be found! (\""+filename+"\")"); + throw new TerminationException(e.getMessage()); + } catch (IOException e) { + System.out.println(" IO ERROR: Could not write to file! (\""+filename+"\")"); + throw new TerminationException(e.getMessage()); + } + } + + public ConfigurationProfile selectProfile(String specifiedProfileName) throws InstantiationException, IllegalAccessException, ClassNotFoundException { + // add all default implicit profile + ConfigurationProfile selectedProfile = null; + ConfigurationProfile allEnabledProfile = (ConfigurationProfile) Class.forName(configurationProfileClassName).newInstance(); + allEnabledProfile.setProfileName("all"); + allEnabledProfile.setProfileVersion(getToolVersion()); + config.getConfigurationProfiles().add(allEnabledProfile); + if (specifiedProfileName != null){ + System.out.println(" Selecting profile \"" + specifiedProfileName + + "\"..."); + selectedProfile = activateProfile(specifiedProfileName); + } + if (selectedProfile == null) { + if (specifiedProfileName != null) { + System.out.println(" Profile \"" + + specifiedProfileName + + "\" not found in configuration. Trying default profile \"" + + config.getDefaultConfigurationProfile() + "\"."); + } else { + System.out.println(" No Profile specified. Trying default profile \"" + + config.getDefaultConfigurationProfile() + "\"."); + } + + specifiedProfileName = config.getDefaultConfigurationProfile(); + selectedProfile = activateProfile(specifiedProfileName); + + } + if (selectedProfile == null) { + System.out.println(" Profile \"" + + specifiedProfileName + + "\" not found in configuration. Auto-selecting \"all\" profile."); + selectedProfile = allEnabledProfile; + } + + return selectedProfile; + } + + // -------------------------------------------------------------------------- + //TODO: Extract configuration management and possibly abstract it for reusability + private ConfigurationProfile activateProfile(String specifiedProfile) { + ConfigurationProfile activatedProfile = null; + + for (int i = 0; i < config.getConfigurationProfiles().size(); i++) { + ConfigurationProfile configurationProfile = (ConfigurationProfile) config + .getConfigurationProfiles().get(i); + if (configurationProfile.getProfileName().toLowerCase().equals( + specifiedProfile.toLowerCase())) { + System.out.println(" Activating profile \"" + specifiedProfile + + "\"..."); + activatedProfile = configurationProfile; + } + } + return activatedProfile; + } + + + public void setToolVersion(String toolVersion) { + this.toolVersion = toolVersion; + } + + + public String getToolVersion() { + return toolVersion; + } + +} Index: /trunk/org.etsi.common/src/org/etsi/common/configuration/ConfigurationProfile.java =================================================================== --- /trunk/org.etsi.common/src/org/etsi/common/configuration/ConfigurationProfile.java (revision 7) +++ /trunk/org.etsi.common/src/org/etsi/common/configuration/ConfigurationProfile.java (revision 7) @@ -0,0 +1,93 @@ +package org.etsi.common.configuration; + +import org.etsi.common.logging.LoggingConfiguration; + +public abstract class ConfigurationProfile { + + protected String profileName; + protected String profileVersion; + protected String resourceExtensionsRegExp = "ttcn|ttcn3|3mp"; + protected String projectExtension = "t3p"; + protected boolean settingRecursiveProcessing = true; + protected boolean settingAbortOnError = true; + protected LoggingConfiguration loggingConfiguration = new LoggingConfiguration(); + protected boolean statShowSummary = true; + protected boolean statShowLOC = true; + + public ConfigurationProfile() { + super(); + } + + public String getProfileName() { + return profileName; + } + + public void setProfileName(String profileName) { + this.profileName = profileName; + } + + public void setSettingRecursiveProcessing(boolean settingRecursiveProcessing) { + this.settingRecursiveProcessing = settingRecursiveProcessing; + } + + public boolean isSettingRecursiveProcessing() { + return settingRecursiveProcessing; + } + + public void setStatShowLOC(boolean statShowLOC) { + this.statShowLOC = statShowLOC; + } + + public boolean isStatShowLOC() { + return statShowLOC; + } + + public void setSettingAbortOnError(boolean settingAbortOnError) { + this.settingAbortOnError = settingAbortOnError; + } + + public boolean isSettingAbortOnError() { + return settingAbortOnError; + } + + public void setProfileVersion(String profileVersion) { + this.profileVersion = profileVersion; + } + + public String getProfileVersion() { + return profileVersion; + } + + public void setLoggingConfiguration(LoggingConfiguration loggingConfiguration) { + this.loggingConfiguration = loggingConfiguration; + } + + public LoggingConfiguration getLoggingConfiguration() { + return loggingConfiguration; + } + + public void setStatShowSummary(boolean statShowSummary) { + this.statShowSummary = statShowSummary; + } + + public boolean isStatShowSummary() { + return statShowSummary; + } + + public void setResourceExtensionsRegExp(String resourceExtensionsRegExp) { + this.resourceExtensionsRegExp = resourceExtensionsRegExp; + } + + public String getResourceExtensionsRegExp() { + return resourceExtensionsRegExp; + } + + public void setProjectExtension(String projectExtension) { + this.projectExtension = projectExtension; + } + + public String getProjectExtension() { + return projectExtension; + } + +} Index: /trunk/org.etsi.common/src/org/etsi/common/configuration/OptionWithID.java =================================================================== --- /trunk/org.etsi.common/src/org/etsi/common/configuration/OptionWithID.java (revision 7) +++ /trunk/org.etsi.common/src/org/etsi/common/configuration/OptionWithID.java (revision 7) @@ -0,0 +1,45 @@ +package org.etsi.common.configuration; + +import org.apache.commons.cli.Option; + +public class OptionWithID extends Option { + + /** + * + */ + private static final long serialVersionUID = -2643329397818768355L; + private int id; + + public OptionWithID(String opt, String longOpt, boolean hasArg, + String description) throws IllegalArgumentException { + super(opt, longOpt, hasArg, description); + } + + public OptionWithID(String longOpt, boolean hasArg, + String description) throws IllegalArgumentException { + super(null, longOpt, hasArg, description); + } + + public OptionWithID(int id, String longOpt, boolean hasArg, + String description) throws IllegalArgumentException { + super(null, longOpt, hasArg, description); + this.setId(id); + } + + public OptionWithID(int id, String longOpt, + String description) throws IllegalArgumentException { + super(null, description); + this.setLongOpt(longOpt); + this.setId(id); + } + + public void setId(int id) { + this.id = id; + } + + public int getId() { + return this.id; + } + + +} Index: /trunk/org.etsi.common/src/org/etsi/common/configuration/OptionsHandler.java =================================================================== --- /trunk/org.etsi.common/src/org/etsi/common/configuration/OptionsHandler.java (revision 7) +++ /trunk/org.etsi.common/src/org/etsi/common/configuration/OptionsHandler.java (revision 7) @@ -0,0 +1,56 @@ +package org.etsi.common.configuration; + +import org.apache.commons.cli.Options; + +public class OptionsHandler { + + private Options options = new Options(); + + public OptionsHandler() { + this.initialize(); + } + + private void initialize() { + + OptionWithID optionWithID; + + optionWithID = new OptionWithID(9, "generate-config", "Generate a new default configuration file at the specified file location"); + optionWithID.setArgs(1); + optionWithID.setArgName("FILE NAME"); + getOptions().addOption(optionWithID); + + optionWithID = new OptionWithID(10, "config", "Configuration file location\n"); + optionWithID.setArgs(1); + optionWithID.setArgName("FILE NAME"); +// optionWithID.setRequired(true); + getOptions().addOption(optionWithID); + + optionWithID = new OptionWithID(20, "profile", "Configuration profile\n"); + optionWithID.setArgs(1); + optionWithID.setArgName("PROFILE NAME"); + getOptions().addOption(optionWithID); + + optionWithID = new OptionWithID(30, "verbosity", "Verbosity level (currently supports ERROR, WARNING and INFORMATION values)\n"); + optionWithID.setArgs(1); + optionWithID.setArgName("LOG LEVEL"); + getOptions().addOption(optionWithID); + + optionWithID = new OptionWithID(40, "output-path", "Destination path for the output (if applicable, otherwise ignored). Overrides the profile setting.\n"); + optionWithID.setArgs(1); + optionWithID.setArgName("PATH"); + getOptions().addOption(optionWithID); + + optionWithID = new OptionWithID(100, "help", "Show this usage information screen\n"); + getOptions().addOption(optionWithID); + + } + + public void setOptions(Options options) { + this.options = options; + } + + public Options getOptions() { + return options; + } + +} Index: /trunk/org.etsi.common/src/org/etsi/common/configuration/ToolConfiguration.java =================================================================== --- /trunk/org.etsi.common/src/org/etsi/common/configuration/ToolConfiguration.java (revision 7) +++ /trunk/org.etsi.common/src/org/etsi/common/configuration/ToolConfiguration.java (revision 7) @@ -0,0 +1,30 @@ +package org.etsi.common.configuration; + +import java.util.ArrayList; + +public abstract class ToolConfiguration { + + private ArrayList ConfigurationProfiles; + private String defaultConfigurationProfile; + + public ToolConfiguration() { + super(); + } + + public ArrayList getConfigurationProfiles() { + return ConfigurationProfiles; + } + + public void setConfigurationProfiles(ArrayList configurationProfiles) { + this.ConfigurationProfiles = configurationProfiles; + } + + public String getDefaultConfigurationProfile() { + return defaultConfigurationProfile; + } + + public void setDefaultConfigurationProfile(String defaultConfigurationProfile) { + this.defaultConfigurationProfile = defaultConfigurationProfile; + } + +} Index: /trunk/org.etsi.common/src/org/etsi/common/exceptions/TerminationException.java =================================================================== --- /trunk/org.etsi.common/src/org/etsi/common/exceptions/TerminationException.java (revision 7) +++ /trunk/org.etsi.common/src/org/etsi/common/exceptions/TerminationException.java (revision 7) @@ -0,0 +1,13 @@ +package org.etsi.common.exceptions; + +public class TerminationException extends Exception { + + private static final long serialVersionUID = -2717985520434639235L; + + public TerminationException(String message) { + super("Errors occurred during execution! Could not continue! \n\t" + message); + System.err.println(super.getMessage()); + System.exit(1); + } + +} Index: /trunk/org.etsi.common/src/org/etsi/common/logging/LogMessage.java =================================================================== --- /trunk/org.etsi.common/src/org/etsi/common/logging/LogMessage.java (revision 7) +++ /trunk/org.etsi.common/src/org/etsi/common/logging/LogMessage.java (revision 7) @@ -0,0 +1,114 @@ +package org.etsi.common.logging; + +import org.etsi.common.logging.LoggingInterface.LogLevel; +import org.etsi.common.logging.LoggingInterface.MessageClass; + +public class LogMessage { + private String prefix; + private String filename; + private int startLine; + private int endLine; + private LogLevel logLevel; + private MessageClass messageClass; + private String message; + private String details; + + public LogMessage(){ + + } + + public LogMessage(String filename, int startLine, int endLine, LogLevel logLevel, MessageClass messageClass, String message, String details){ + this.setFilename(filename); + this.setStartLine(startLine); + this.setEndLine(endLine); + this.setLogLevel(logLevel); + this.setMessageClass(messageClass); + this.setMessage(message); + this.setDetails(details); + } + + public String toString(){ + String output = ""; + output += getPrefix(); + if (getFilename() != null) { + output += getFilename() + ": "; + } + + if (getStartLine() >= getEndLine()) { + output += getStartLine() + ": "; + } else { + output += getStartLine() + "-" + getEndLine() + ": "; + } + + output += getLogLevel() + ": "; + + if (getMessageClass() != null) { + output += getMessageClass().getDescription() + ": "; + } + + output += getMessage(); + + if (getDetails() != null) { + output += " (" + getDetails() + ")"; + } + + return output; + } + + + public int getStartLine() { + return startLine; + } + public void setStartLine(int startLine) { + this.startLine = startLine; + } + public int getEndLine() { + return endLine; + } + public void setEndLine(int endLine) { + this.endLine = endLine; + } + public LogLevel getLogLevel() { + return logLevel; + } + public void setLogLevel(LogLevel logLevel) { + this.logLevel = logLevel; + } + public MessageClass getMessageClass() { + return messageClass; + } + public void setMessageClass(MessageClass messageClass) { + this.messageClass = messageClass; + } + public String getMessage() { + return message; + } + public void setMessage(String message) { + this.message = message; + } + public String getDetails() { + return details; + } + public void setDetails(String details) { + this.details = details; + } + + + public void setFilename(String filename) { + this.filename = filename; + } + + + public String getFilename() { + return filename; + } + + public void setPrefix(String prefix) { + this.prefix = prefix; + } + + public String getPrefix() { + return prefix; + } + +} Index: /trunk/org.etsi.common/src/org/etsi/common/logging/LoggingConfiguration.java =================================================================== --- /trunk/org.etsi.common/src/org/etsi/common/logging/LoggingConfiguration.java (revision 7) +++ /trunk/org.etsi.common/src/org/etsi/common/logging/LoggingConfiguration.java (revision 7) @@ -0,0 +1,41 @@ +package org.etsi.common.logging; + +public class LoggingConfiguration { + private boolean showFullPath = false; + private boolean showFilename = true; + private boolean showMessageClass = true; + private boolean showDetails = true; + private String logOutputPrefix = " "; + + public boolean isShowFullPath() { + return showFullPath; + } + public void setShowFullPath(boolean showFullPath) { + this.showFullPath = showFullPath; + } + public boolean isShowFilename() { + return showFilename; + } + public void setShowFilename(boolean showFilename) { + this.showFilename = showFilename; + } + public boolean isShowMessageClass() { + return showMessageClass; + } + public void setShowMessageClass(boolean showMessageClass) { + this.showMessageClass = showMessageClass; + } + public boolean isShowDetails() { + return showDetails; + } + public void setShowDetails(boolean showDetails) { + this.showDetails = showDetails; + } + public void setLogOutputPrefix(String logOutputPrefix) { + this.logOutputPrefix = logOutputPrefix; + } + public String getLogOutputPrefix() { + return logOutputPrefix; + } + +} Index: /trunk/org.etsi.common/src/org/etsi/common/logging/LoggingInterface.java =================================================================== --- /trunk/org.etsi.common/src/org/etsi/common/logging/LoggingInterface.java (revision 7) +++ /trunk/org.etsi.common/src/org/etsi/common/logging/LoggingInterface.java (revision 7) @@ -0,0 +1,291 @@ +package org.etsi.common.logging; + + +import org.etsi.common.MiscTools; + +public class LoggingInterface { + + public enum LogLevel { + //ORDER MATTERS + ERROR, + WARNING, + INFORMATION, + FIXME, + DEBUG; + } + + public enum MessageClass { + //ORDER MATTERS + UNIVERSAL ("Universal", 0), + GENERAL ("General", 1), + NAMING ("Naming Conventions", 2), + DOCUMENTATION ("Code Documentation", 3), + LOGGING ("Log Statements", 4), + STRUCTURE ("Structure of Data", 5), + STYLE ("Code Style", 6), + MODULARIZATION ("Test Suite Modularization", 7); + + private final String description; + private final int id; + private int occurenceCount = 0; + + MessageClass (String description, int id){ + this.description = description; + this.id = id; + } + + public String getDescription() { + return description; + } + + public int getId() { + return id; + } + + public void addOccurence() { + this.occurenceCount++; + } + + public int getOccurenceCount() { + return occurenceCount; + } + } + + private String logSourceName = ""; + private LogLevel maximumLogLevel = LogLevel.INFORMATION; + private LogLevel defaultLogLevel = LogLevel.INFORMATION; + private LoggingConfiguration configuration = new LoggingConfiguration(); + + public LoggingInterface(LoggingConfiguration logConfiguration) { + this.setConfiguration(logConfiguration); + } + + public LoggingInterface(String logSourceName, LoggingConfiguration logConfiguration){ + this(logConfiguration); + this.setLogSourceName(logSourceName); + } + public LoggingInterface(String logSourceName, LoggingConfiguration logConfiguration, LogLevel maximumLogLevel){ + this(logSourceName, logConfiguration); + this.setMaximumLogLevel(maximumLogLevel); + } + + private LogMessage createLogMessage(LogLevel l, int startLine, int endLine, MessageClass messageClass, String message, String details){ + LogMessage logMessage = new LogMessage(); + logMessage.setPrefix(this.getConfiguration().getLogOutputPrefix()); + + if (this.getConfiguration().isShowFullPath()) { + logMessage.setFilename(this.getLogSourceName()); + } else { + if (this.getConfiguration().isShowFilename()) { + logMessage.setFilename(MiscTools.getShortFilename(this + .getLogSourceName())); + } + } + logMessage.setStartLine(startLine); + logMessage.setEndLine(endLine); + logMessage.setLogLevel(l); + + messageClass.addOccurence(); + + if (this.getConfiguration().isShowMessageClass()) { + logMessage.setMessageClass(messageClass); + } else { + logMessage.setMessageClass(null); + } + + logMessage.setMessage(message); + + if (this.getConfiguration().isShowDetails() && details != null) { + logMessage.setDetails(details); + } else { + logMessage.setDetails(null); + } + + return logMessage; + } + +/* private String composeLogMessage(LogLevel l, int startLine, int endLine, MessageClass messageClass, String message, String details){ + String composedLogMessage = ""; + + composedLogMessage += this.getConfiguration().getLogOutputPrefix(); + + if (this.getConfiguration().isShowFullPath()) { + composedLogMessage += this.getLogSourceName() + ": "; + } else { + if (this.getConfiguration().isShowFilename()) { + composedLogMessage += MiscTools.getShortFilename(this + .getLogSourceName()) + + ": "; + } + } + + if (startLine >= endLine) { + composedLogMessage += startLine + ": "; + } else { + composedLogMessage += startLine + "-" + endLine + ": "; + } + + composedLogMessage += l + ": "; + + if (this.getConfiguration().isShowMessageClass()) { + composedLogMessage += messageClass.getDescription() + ": "; + } + + composedLogMessage += message; + + if (this.getConfiguration().isShowDetails() && details != null) { + composedLogMessage += "(" + details + ")"; + } + + return composedLogMessage; + } +*/ + + public void logMessage(LogLevel l, int startLine, int endLine, MessageClass messageClass, String message, String details){ + if (showLogLevel(l)){ + LogMessage composedLogMessage = createLogMessage(l, startLine, endLine, messageClass, message, details); + outputLog(composedLogMessage); + } + } + + public void logMessage(LogLevel l, int startLine, int endLine, MessageClass messageClass, String message){ + if (showLogLevel(l)){ + LogMessage composedLogMessage = createLogMessage(l, startLine, endLine, messageClass, message, null); + outputLog(composedLogMessage); + } + } + + public void logMessage(int startLine, int endLine, MessageClass messageClass, String message, String details){ + if (showLogLevel(this.getDefaultLogLevel())){ + LogMessage composedLogMessage = createLogMessage(this.getDefaultLogLevel(), startLine, endLine, messageClass, message, details); + outputLog(composedLogMessage); + } + } + + + public void logMessage(int startLine, int endLine, MessageClass messageClass, String message){ + if (showLogLevel(this.getDefaultLogLevel())){ + LogMessage composedLogMessage = createLogMessage(this.getDefaultLogLevel(), startLine, endLine, messageClass, message, null); + outputLog(composedLogMessage); + } + } + + +// private void outputLog(String composedLogMessage){ +// System.out.println(composedLogMessage); +// } + + private void outputLog(LogMessage composedLogMessage){ + System.out.println(composedLogMessage.toString()); + } + + public void logWarning(int startLine, int endLine, MessageClass messageClass, String message){ + if (showLogLevel(LogLevel.WARNING)){ + LogMessage composedLogMessage = createLogMessage(LogLevel.WARNING, startLine, endLine, messageClass, message, null); + outputLog(composedLogMessage); + } + } + + public void logWarning(int startLine, int endLine, MessageClass messageClass, String message, String details){ + if (showLogLevel(LogLevel.WARNING)){ + LogMessage composedLogMessage = createLogMessage(LogLevel.WARNING, startLine, endLine, messageClass, message, details); + outputLog(composedLogMessage); + } + + } + + public void logDebug(int startLine, int endLine, MessageClass messageClass, String message){ + if (showLogLevel(LogLevel.DEBUG)){ + LogMessage composedLogMessage = createLogMessage(LogLevel.DEBUG, startLine, endLine, messageClass, message, null); + outputLog(composedLogMessage); + } + + } + + public void logDebug(int startLine, int endLine, MessageClass messageClass, String message, String details){ + if (showLogLevel(LogLevel.DEBUG)){ + LogMessage composedLogMessage = createLogMessage(LogLevel.DEBUG, startLine, endLine, messageClass, message, details); + outputLog(composedLogMessage); + } + + } + + public void logFix(int startLine, int endLine, MessageClass messageClass, String message){ + if (showLogLevel(LogLevel.FIXME)){ + LogMessage composedLogMessage = createLogMessage(LogLevel.FIXME, startLine, endLine, messageClass, message, null); + outputLog(composedLogMessage); + } + + } + + public void logFix(int startLine, int endLine, MessageClass messageClass, String message, String details){ + if (showLogLevel(LogLevel.FIXME)){ + LogMessage composedLogMessage = createLogMessage(LogLevel.FIXME, startLine, endLine, messageClass, message, details); + outputLog(composedLogMessage); + } + + } + + + public void logError(int startLine, int endLine, MessageClass messageClass, String message){ + if (showLogLevel(LogLevel.ERROR)){ + LogMessage composedLogMessage = createLogMessage(LogLevel.ERROR, startLine, endLine, messageClass, message, null); + outputLog(composedLogMessage); + } + } + + public void logInformation(int startLine, int endLine, MessageClass messageClass, String message){ + if (showLogLevel(LogLevel.INFORMATION)){ + LogMessage composedLogMessage = createLogMessage(LogLevel.INFORMATION, startLine, endLine, messageClass, message, null); + outputLog(composedLogMessage); + } + } + + public void logInformation(int startLine, int endLine, MessageClass messageClass, String message, String detail){ + if (showLogLevel(LogLevel.INFORMATION)){ + LogMessage composedLogMessage = createLogMessage(LogLevel.INFORMATION, startLine, endLine, messageClass, message, detail); + outputLog(composedLogMessage); + } + } + + + public String getLogSourceName() { + return logSourceName; + } + + + public void setMaximumLogLevel(LogLevel maximumLogLevel) { + this.maximumLogLevel = maximumLogLevel; + } + + public LogLevel getMaximumLogLevel() { + return maximumLogLevel; + } + + public boolean showLogLevel(LogLevel logLevel) { + boolean show = false; + if (logLevel.ordinal() <= this.getMaximumLogLevel().ordinal()){ + show = true; + } + return show; + } + + public void setConfiguration(LoggingConfiguration configuration) { + this.configuration = configuration; + } + public LoggingConfiguration getConfiguration() { + return configuration; + } + public void setDefaultLogLevel(LogLevel defaultLogLevel) { + this.defaultLogLevel = defaultLogLevel; + } + public LogLevel getDefaultLogLevel() { + return defaultLogLevel; + } + public void setLogSourceName(String logSourceName) { + this.logSourceName = logSourceName; + } + + + +} Index: /trunk/org.etsi.common/src/org/etsi/common/logging/LoggingStatistics.java =================================================================== --- /trunk/org.etsi.common/src/org/etsi/common/logging/LoggingStatistics.java (revision 7) +++ /trunk/org.etsi.common/src/org/etsi/common/logging/LoggingStatistics.java (revision 7) @@ -0,0 +1,25 @@ +package org.etsi.common.logging; + +import java.util.HashMap; + +import org.etsi.common.logging.LoggingInterface.MessageClass; + + +//TODO: currently not in use +public class LoggingStatistics { + private HashMap statsMap = new HashMap(); + + public LoggingStatistics(){ + for (MessageClass c : MessageClass.values()){ + this.statsMap.put(c, 0); + } + } + + public void addOccurence(MessageClass c){ + this.statsMap.put(c, this.statsMap.get(c) + 1); + } + + public int getOccurences(MessageClass c){ + return this.statsMap.get(c); + } +} Index: /trunk/t3d-examples/.project =================================================================== --- /trunk/t3d-examples/.project (revision 7) +++ /trunk/t3d-examples/.project (revision 7) @@ -0,0 +1,11 @@ + + + t3d-examples + + + + + + + + Index: /trunk/t3d-examples/basics/configuration.ttcn3 =================================================================== --- /trunk/t3d-examples/basics/configuration.ttcn3 (revision 7) +++ /trunk/t3d-examples/basics/configuration.ttcn3 (revision 7) @@ -0,0 +1,46 @@ +module configuration { + //import from types all; + group ports{ + type port samplePortM1 message{ + inout charstring, integer + } + type port samplePortM2 message{ + inout sampleType1 + } + } + + group test_components{ + type component sampleComponent1{ + port samplePortM1 p1 + port samplePortM2 p2 + timer t1 + } + /* + @desc description + */ + type component sampleComponent3{ + port samplePortM1 p1 + port samplePortM2 p2 + } + + type component sampleComponent2{ + port samplePortM1 p1 + port samplePortM2 p2 + timer t1, t2, t3 + const sampleType1 c1 := 1 + + + } + + + } + //not used, not documented(?) + group components{ + type component sampleComponentX{ + port samplePortM1 p1 + port samplePortM2 p2 + timer t1, t2, t3 + const sampleType1 c1 := 1 + } + } +} Index: /trunk/t3d-examples/basics/functions.ttcn3 =================================================================== --- /trunk/t3d-examples/basics/functions.ttcn3 (revision 7) +++ /trunk/t3d-examples/basics/functions.ttcn3 (revision 7) @@ -0,0 +1,54 @@ +module functions { + import from types all; + import from configuration all; + group mtcFunctions { + /* + @desc Given the security cababilities of an UE (e.g. from an ATTACH + * REQUEST/UE network capabilities IE) this function creates a new value for + * the security capabilities which is invalid for the current UE. To achieve + * this, the original capabilities are inverted. + * @param p_SecurityCaps Security capabilities as reported by the UE. + @return Security capabilities which are invalid for the current UE. + */ + + function f1 () + runs on sampleComponent1 { + p1.send ( integer:1 ); + p2.receive ( charstring:"a" ); + } + //@desc description + //@param par1, par2 + function f2 ( + integer par1, + charstring par2 + ) + runs on sampleComponent1 { + p1.receive ( integer:par1 ); + p2.send ( charstring:par2 ); + } + } + + group ptcFunctions { + //*@desc description + function f3 () + runs on sampleComponent2 { + p1.send ( integer:1 ); + p2.receive ( charstring:"a" ); + } + + /* + //@desc description + //@param par1, par2 + */ + + function f4 ( + sampleType1 par1, + sampleType2 par2 + ) + runs on sampleComponent2 { + p1.receive ( integer:par1 ); + p2.send ( charstring:par2 ); + } + } + +} Index: /trunk/t3d-examples/basics/import1.ttcn3 =================================================================== --- /trunk/t3d-examples/basics/import1.ttcn3 (revision 7) +++ /trunk/t3d-examples/basics/import1.ttcn3 (revision 7) @@ -0,0 +1,4 @@ +module import1 { + import from import2 all; + import from import4 all; +} Index: /trunk/t3d-examples/basics/import2.ttcn3 =================================================================== --- /trunk/t3d-examples/basics/import2.ttcn3 (revision 7) +++ /trunk/t3d-examples/basics/import2.ttcn3 (revision 7) @@ -0,0 +1,5 @@ +module import2 { + import from import3 all; + import from import1 all; + import from import4 all; +} Index: /trunk/t3d-examples/basics/import3.ttcn3 =================================================================== --- /trunk/t3d-examples/basics/import3.ttcn3 (revision 7) +++ /trunk/t3d-examples/basics/import3.ttcn3 (revision 7) @@ -0,0 +1,4 @@ +module import3 { + import from import1 all; + import from import4 all; +} Index: /trunk/t3d-examples/basics/import4.ttcn3 =================================================================== --- /trunk/t3d-examples/basics/import4.ttcn3 (revision 7) +++ /trunk/t3d-examples/basics/import4.ttcn3 (revision 7) @@ -0,0 +1,3 @@ +module import4 { + import from import1 all; +} Index: /trunk/t3d-examples/basics/localDependencies.ttcn3 =================================================================== --- /trunk/t3d-examples/basics/localDependencies.ttcn3 (revision 7) +++ /trunk/t3d-examples/basics/localDependencies.ttcn3 (revision 7) @@ -0,0 +1,53 @@ +module localDependencies { + + type enumerated enumtype { + enum1, enum2 + } + type enumerated enumtype2 { + enum2, enum1 + } + + modulepar { + typeX pp1, pp2 := int2string(2), pp4:=someConst; + typeY pp31 := someConst, pp5; + + } + + modulepar typeZ pp6, pp7; + + //* @desc 1 + template typeX templateY :={ + fieldZ := 1 + } + + //* @desc 1 + function f1(typeX par1 := templateY){ + var enumtype ve1; + ve1:=enum1; + if (ve1 == enum1){ + } + if (enum1 > enum2){ +// + } + f2(); + f2(); + f3(); + } + + function fr1(enumtype p1) return enumtype2{ + return enum1; + } + + function f2(){ + //f1(); + f3(); + fx(cx); + fr1(enum1) + if (enum2 == fr1(1)){ + + } + + } + external function fx(typeX p1); + external const integer cx; +} Index: /trunk/t3d-examples/basics/main.ttcn3 =================================================================== --- /trunk/t3d-examples/basics/main.ttcn3 (revision 7) +++ /trunk/t3d-examples/basics/main.ttcn3 (revision 7) @@ -0,0 +1,14 @@ +module main { + import from configuraiton all; + import from functions all; + import from types all; + import from templates all; + import from types all; + import from testacases all; + + control { + execute(tc1()); + execute(tc2()); + } + +} Index: /trunk/t3d-examples/basics/modulepars.ttcn3 =================================================================== --- /trunk/t3d-examples/basics/modulepars.ttcn3 (revision 7) +++ /trunk/t3d-examples/basics/modulepars.ttcn3 (revision 7) @@ -0,0 +1,50 @@ +// * @version 1.1.1.1.1.1.1.1.1.1.1.1.1.1.1.1.0 +// * @author John Doe +// * @author John Doe +// * @remark this is the module + +module modulepars{ + +// * @version 1.1.1.1.1.1.1.1.1.1.1.1.1.1.1.1.0 +// * @author John Doe +// * @author John Doe +// * @remark this is the modulepar +modulepar{ + octetstring px_AccessPointName; + B16_Type px_AuthAMF; + B128_Type px_AuthK := oct2bit ( '000102030405060708090A0B0C0D0E0F'O ); + integer px_AuthN := 127; + hexstring px_IMEI_Def; + hexstring px_IMSI_Def := '001010123456063'H; + charstring px_IP_Address; + B3_Type px_NAS_CipheringAlgorithm := '001'B; + B3_Type px_NAS_IntegrityProtAlgorithm := '001'B; + boolean px_RLC_SDU_Buffering := true; + CipheringAlgorithm_Type px_RRC_CipheringAlgorithm := eea0; + IntegrityProtAlgorithm_Type px_RRC_IntegrityProtAlgorithm := eia1; + integer px_SupportedEutraBands := 1; + integer px_SupportedInterRatBands := 1; + B128_Type px_eAuthRAND := oct2bit ( 'A3DE0C6D363E30C364A4078F1BF8D577'O ); + Dl_Bandwidth_Type px_eDLChannelBandwidth := n25; + NAS_Mcc px_eJapanMCC_Band6 := '442'H; + FrequencyBand_Type px_ePrimaryFrequencyBand := 1; + FrequencyBand_Type px_eSecondaryFrequencyBand := 2; + Ul_Bandwidth_Type px_eULChannelBandwidth := n25; + }; + + modulepar integer bla := 127; + + modulepar integer bla11 := 127, bla12 := 127; + + modulepar CipheringAlgorithm_Type bla21, bla22; + + + modulepar{ + integer blax := 127; + integer blax11 := 127, blax12 := 127; + CipheringAlgorithm_Type blax21, blax22; + } + + modulepar integer thisisalongmoduleparameternamethatgoesonandonandonandonandonandonandonandonandonandonandonandonandonandonandonandonandonandonandonandonandonandonandonandonandonandonandonandonandonandonandonandonEND := 234243623463563563635543535654656; + +} Index: /trunk/t3d-examples/basics/templates.ttcn3 =================================================================== --- /trunk/t3d-examples/basics/templates.ttcn3 (revision 7) +++ /trunk/t3d-examples/basics/templates.ttcn3 (revision 7) @@ -0,0 +1,15 @@ +module templates { + group g1{ + group sub_g1{ + + } + + group sub_g2{ + + } + } + + group g2{ + + } +} Index: /trunk/t3d-examples/basics/templates2.ttcn3 =================================================================== --- /trunk/t3d-examples/basics/templates2.ttcn3 (revision 7) +++ /trunk/t3d-examples/basics/templates2.ttcn3 (revision 7) @@ -0,0 +1,15 @@ +module templates { + group g1x{ + group sub_g1x{ + + } + + group sub_g2x{ + + } + } + + group g2x{ + + } +} Index: /trunk/t3d-examples/basics/testcases.ttcn3 =================================================================== --- /trunk/t3d-examples/basics/testcases.ttcn3 (revision 7) +++ /trunk/t3d-examples/basics/testcases.ttcn3 (revision 7) @@ -0,0 +1,30 @@ +module testcases { + import from types all; + import from configuration all; + import from functions all; + testcase tc1() runs on sampleComponent1 system sampleComponent3{ + map(mtc:p1, system:p1) + map(mtc:p2, system:p2) + + f1(); + f2(1, "a") + + unmap(mtc:p1, system:p1) + unmap(mtc:p2, system:p2) + + } + + testcase tc2() runs on sampleComponent1 system sampleComponent3{ + map(mtc:p1, system:p1) + var sampleComponent2 component2, component3; + component2 := sampleComponent2.create; + component3 := sampleComponent2.create; + + component2.start(f3()); + component3.start(f4(1, "a")); + + unmap(mtc:p1, system:p1) + + } + +} Index: /trunk/t3d-examples/basics/types.ttcn3 =================================================================== --- /trunk/t3d-examples/basics/types.ttcn3 (revision 7) +++ /trunk/t3d-examples/basics/types.ttcn3 (revision 7) @@ -0,0 +1,21 @@ +module types { + + group subtypes { + type integer sampleType1 (0,1,2,3); + type charstring sampleType2 ("a", "b", "c") + } + group records { + type record sampleType3 { + integer field1, + charstring field2 + } + type record sampleType4 { + integer field1, + charstring field2, + boolean field3 + + } + + + } +} Index: /trunk/t3d-examples/t3dtest/Examplemodule.ttcn =================================================================== --- /trunk/t3d-examples/t3dtest/Examplemodule.ttcn (revision 7) +++ /trunk/t3d-examples/t3dtest/Examplemodule.ttcn (revision 7) @@ -0,0 +1,28 @@ + /* + * @author John Doe + * @desc This is an example of a module in ttcn-3 + */ + module Examplemodule { + const integer con1 :=1, con2:=2; + + + import from groupTest recursive all; + import from functionalityTest {group types}; + import from undocumentedParameters all; + + group ExampleGroup { + /* + * @author John Doe + * @author Jane Doe + * @version v0.1.4 + * @remark an embedded tag is used here, @see ExampleFunction + */ + testcase ExampleTestcase() runs on Examplecomponent{ + // TTCN-3 testcase code + } + } + function ExampleFunction (in charstring par1, out charstring par2) + return boolean { + // TTCN-3 function code + } + } Index: /trunk/t3d-examples/t3dtest/commentTest.ttcn =================================================================== --- /trunk/t3d-examples/t3dtest/commentTest.ttcn (revision 7) +++ /trunk/t3d-examples/t3dtest/commentTest.ttcn (revision 7) @@ -0,0 +1,332 @@ +/** + * @author STF 339 + * @author STF 341 + * @version $Id: AtsDpmr_Types.ttcn 87 2008-02-22 15:53:29Z petersenj $ + * @desc Data type @see functionalityTest.noelement BLA BLA BLA definitions for @see f_1 information elements for digital Public @see functionalityTest.f_1 + * Mobile Radio (dPMR) messages @see f_1 + * @see s_test1 + * @see f_1 + * @see functionalityTest.f_1 + * @see onality.f_1 + * @see noelement + * @see functionalityTest.noelement + * @see functionalityTest.1 + * @see 1 + * @remark + */ +module comment_Test { +// useless +/* + * @desc desc1_line1 desc1_line1 desc1_line1 desc1_line1 desc1_line1 @see noelement @see functionalityTest.f_1 desc1_line1 desc1_line1 desc1_line1 desc1_line1 desc1_line1 desc1_line1 desc1_line1 + * * desc1_line2 desc1_line2 @see functionalityTest.noelement BLA BLA BLA desc1_line2 @see functionalityTest.f_1 desc1_line2 desc1_line2 desc1_line2 @see functionalityTest.f_1 + * @param param1_line1 param1_line1 param1_line1 param1_line1 @see f_1 + * * param1_line2 param1_line2 param1_line2 **stars** @see f_test + * @param param2_line1 @see f_test param2_line1 + @remark THIS IS FALSE + * @remark + */ +// * @remark THIS IS IMPORTANT +//useless + /* + * @desc desc2_line1 @see functionalityTest.f_1 desc2_line1 desc2_line1 desc2_line1 desc2_line1 desc2_line1 desc2_line1 desc2_line1 desc2_line1 + * desc2_line2 desc2_line2 desc2_line2 desc2_line2 desc2_line2 desc2_line2 + * @desc desc3_line1 desc3_line1 desc3_line1 desc3_line1 @see f_test + * desc3_line2 + @param param3_line1 param3_line1 param3_line1 param3_line1 + * param3_line2 param3_line2 param3_line2 + @param param4_line1 param4_line1 + */ + /* + // * @param param5_line1 param5_line1 param5_line1 param5_line1 + param5_line2 param5_line2 param5_line2 + @param param6_line1 param6_line1 + @desc desc4_line1 desc4_line1 desc4_line1 desc4_line1 desc4_line1 +// * desc4_line2 desc4_line2 desc4_line2 + */ +// useless + function f_test ( inout StringStack p_stack, in charstring p_item ) { + p_stack.stringItems[p_stack.stackSize] := p_item; + p_stack.stackSize := p_stack.stackSize + 1; + } + + function f_1 ( inout StringStack p_stack, in charstring p_item ) { + p_stack.stringItems[p_stack.stackSize] := p_item; + p_stack.stackSize := p_stack.stackSize + 1; + } + + + + /* + + * @desc text text text text text text text + * text text text text text text text text + * text text text text text text text text + * text text text text text text text text + * text text text text text text text text + * text text text text text text text text + * text text text text text text text text + * text text text text text text text text + * text text text text text text text text + * text text text text text text text text + * text text text text text text text text + * text text text text text text text text + * text text text text text text text text + * text text text text text text text text + * text text text text text text text text + * text text text text text text text text + * text text text text text text text text + * text text text text text text text text + * text text text text text text text text + * text text text text text text text text + * text text text text text text text text + * text text text text text text text text + * text text text text text text text text + * text text text text text text text text + * text text text text text text text text + * text text text text text text text text + * text text text text text text text text + * text text text text text text text text + * text text text text text text text text + * text text text text text text text text + * text text text text text text text text + * text text text text text text text text + + */ + function f_test2 ( inout StringStack p_stack, in charstring p_item ) runs on floor return integer{ + p_stack.stringItems[p_stack.stackSize] := p_item; + p_stack.stackSize := p_stack.stackSize + 1; + } + + + /* + + * @desc DDDDDDDDDDDescription @see DontSee + * @author Author1 + * @author Author2 + * @config Config + * @exception Exception + * @member Member members + * @param Parameter1 param1_desc + * @param Parameter2 param2_desc + * @purpose Purpose + * @remark Remark + * @return Return + * @see See + * @since Since + * @status Status + * @url http://url.tld + * @verdict Verdict + * @version Version + + + */ + +group alltest{ + /* + + * @desc Description @see DontSee + * @author Author1 + * @author Author2 + * @config Config + * @exception Exception + * @member Member members + * @param Parameter1 param1_desc + * @param Parameter2 param2_desc + * @purpose Purpose + * @remark Remark blabla bla @url http://www.uni-goettingen.de bla bla @url http://www.uni-goettingen.de + * @return Return + * @see See + * @since Since + * @status Status + * @url http://url.tld + * @verdict Verdict + * @version Version + + + */ + function f_test3 ( inout StringStack p_stack, in charstring p_item ) { + p_stack.stringItems[p_stack.stackSize] := p_item; + p_stack.stackSize := p_stack.stackSize + 1; + } + + + /* + + * @desc Description @see DontSee + * @author Author1 + * @author Author2 + * @config Config + * @exception Exception + * @member Member members + * @param Parameter1 param1_desc + * @param Parameter2 param2_desc + * @purpose Purpose + * @remark Remark + * @return Return + * @see See + * @since Since + * @status Status + * @url http://url.tld + * @verdict Verdict + * @version Version + + + */ + +altstep a_test1() runs on floor + { + [] server.receive + { + setverdict(fail); + stop + } + [] client.receive + { + setverdict(fail); + stop + } + [] secServer.receive + { + setverdict(fail); + stop + } + [] secClient.receive + { + setverdict(fail); + stop + } + [] ipCANctl.receive + { + setverdict(inconc); + stop + } + [] ipConf.receive + { + setverdict(inconc); + stop + } + [] TGuard.timeout + {setverdict(inconc); stop} + [] any timer.timeout + {setverdict(fail); stop} + } + + /* + + * @desc Description @see DontSee + * @author Author1 + * @author Author2 + * @config Config + * @exception Exception + * @member Member members + * @param Parameter1 param1_desc + * @param Parameter2 param2_desc + * @purpose Purpose + * @remark Remark + * @return Return + * @see See + * @since Since + * @status Status + * @url http://url.tld + * @verdict Verdict + * @version Version + + + */ + +testcase t_test1() runs on MTC system SystemInterface { + // Mobile terminated location request/ UE-Based GPS + + // Test Purpose: + // To verify that when the UE receives a REGISTER message during an established CS call, + // containing a LCS Location Notification Invoke component set to NotifyLocationAllowed, + // the UE displays information about the LCS client correctly and sends a RELEASE COMPLETE message + // containing a LocationNotification return result with verificationResponse set to permissionGranted. + // To verify that the UE responds with a Measurement Report message containing UE location when the + // assistance data is divided between several Measurement Control messages using Measurement Command ?Modify?. + + var UTRANComponent UtranPTC := UTRANComponent.create alive; + var GERANComponent GeranPTC := null; + + var MTC_mirror MtcPTC_mirror; + var UTRANComponent_mirror UtranPTC_mirror; + var GERANComponent_mirror GeranPTC_mirror; + + if (pc_is_Intra==true) { + MtcPTC_mirror:=MTC_mirror.create; + UtranPTC_mirror:=UTRANComponent_mirror.create alive; + GeranPTC_mirror:=GERANComponent_mirror.create alive; + } else { + MtcPTC_mirror:=null; + UtranPTC_mirror:=null; + GeranPTC_mirror:=null; + } + + MTC_Main_Map(self, MtcPTC_mirror); // Maps or connects + UTRAN_Map(UtranPTC, UtranPTC_mirror); // Maps or connects + MTC_ConnectPTCs(self, UtranPTC, GeranPTC); + + if (MtcPTC_mirror!=null) { + MtcPTC_mirror.start(TC_17_2_4_1_asPTC_mirror(UtranPTC_mirror, GeranPTC_mirror)); + } + + UtranPTC.start(TC_17_2_4_1_UTRAN()); + MTC_Main_Behaviour(); + } + + /* + + * @desc Description @see DontSee + * @author Author1 + * @author Author2 + * @config Config + * @exception Exception + * @member Member members + * @param Parameter1 param1_desc + * @param Parameter2 param2_desc + * @purpose Purpose + * @remark Remark + * @return Return + * @see See + * @since Since + * @status Status + * @url http://url.tld + * @verdict Verdict + * @version Version + + + */ + + signature s_test1() return returntype; + +/* + * @config blabla + * @config blabla + + * @purpose blabla + * @purpose blabla + + * @return blabla + * @return blabla + + * @since blabla + * @since blabla + + * @status blabla + * @status blabla + + * @version blabla + * @version blabla + + +*/ + signature s_toomanytags() return integer; + +} + // * @desc identical tag here +signature s_identicalDescTags_1() return integer; + + // * @desc identical tag here +signature s_identicalDescTags_1() return integer; + +} Index: /trunk/t3d-examples/t3dtest/functionalitytest.ttcn =================================================================== --- /trunk/t3d-examples/t3dtest/functionalitytest.ttcn (revision 7) +++ /trunk/t3d-examples/t3dtest/functionalitytest.ttcn (revision 7) @@ -0,0 +1,76 @@ +/** + * @author STF 340 + * @version $Id: AtsDpmr_Types.ttcn 87 2008-02-22 15:53:29Z petersenj $ + * @desc Data type definitions for information elements for digital Public + * Mobile Radio (dPMR) messages + */ +module functionalityTest { + + import from Examplemodule {group ExampleGroup}; + import from Examplemodule {function ExampleFunction, ExampleFunction; const con2}; + import from Examplemodule {const con1}; + import from Examplemodule all except {const con1, con2; function all}; + import from Examplemodule recursive all; + + + group types{ + + group Structured{ + type component Comp{}; + + type record Rec{}; + + type integer Int; + + type set of Rec SetOfRec; + + type port Port message{ + in Rec; + out Rec; + }; + + type enumerated Enum{ Rec, Int}; + + type set Set{}; + + type record of Rec RecordOfRec; + + type union Union{RecordOfRec un1, SetOfRec un2}; + + } + group subtype{ + type Rec RecType; + + type integer IntType; + + } + + } + + group functions{ + + function f_1(Comp par1, Rec par2, boolean par3) runs on Rec{ + var Port var1; + if(par3){ + + } else{ + + } + } + + + } + + + + group constants{ + + const integer c1 := 1, c2 := 2; + + + } + + + + +} Index: /trunk/t3d-examples/t3dtest/grouptest.ttcn =================================================================== --- /trunk/t3d-examples/t3dtest/grouptest.ttcn (revision 7) +++ /trunk/t3d-examples/t3dtest/grouptest.ttcn (revision 7) @@ -0,0 +1,41 @@ +/** + * @author STF 340 + * @version $Id: AtsDpmr_Types.ttcn 87 2008-02-22 15:53:29Z petersenj $ + * @desc Data type definitions for information elements for digital Public + * Mobile Radio (dPMR) messages + */ +module groupTest { + import from functionalityTest all; + group group1{ + group group1_1{ + group group1_1_1{ + } + } + group group1_2{ + } + group group1_3{ + group group1_3_1{ + modulepar integer y:=4; + group group1_3_1_1{ + modulepar integer x:=3; + } + group group1_3_1_2{ + } + } + } + + + } + + group group2{ + } + + group group3{ + group group3_1{ + } + group group3_2{ + } + + } + +} Index: /trunk/t3d-examples/t3dtest/module_with_moduleParameters.ttcn3 =================================================================== --- /trunk/t3d-examples/t3dtest/module_with_moduleParameters.ttcn3 (revision 7) +++ /trunk/t3d-examples/t3dtest/module_with_moduleParameters.ttcn3 (revision 7) @@ -0,0 +1,110 @@ +module module_with_moduleParameters { + modulepar boolean par1 := true; + modulepar boolean par2 := true; + modulepar boolean par3 := false; + + modulepar boolean par41, par42, par43 := false; + + const integer con1 := 1, con2 := 2; + + + + testcase t_1() runs on bla system blubb{ + + if(f_1(par2)){ + + } + + if(f_3()){ + + } + } + + testcase t_2(boolean tpar) runs on bla system blubb{ + + } + + function f_1( boolean fpar){ + var boolean var1 := f_2(fpar); + return f_5(var1, var1); + } + function f_2(boolean fpar){ + return (fpar == false); + } + function f_3(){ + var boolean var1 := f_4(); + t_2(var1); + return var1; + } + + function f_4(){ + return par3; + } + function f_5(boolean fpar, boolean fpar){ + return (fpar == false); + } + + + testcase testcaseAll() runs on MTC system SystemInterface { + if (par1==true) {} else {} + if (par2==true) {} else {} + if (par3==true) {} else {} + if (par41==true) {} else {} + if (par42==true) {} else {} + if (par43==true) {} else {} + if (con1==1) {} else {} + if (con2==1) {} else {} + } + + testcase testcase1() runs on MTC system SystemInterface { + if (par1==true) {} else {}} + + testcase testcase1_2() runs on MTC system SystemInterface { + if (par1==true) {} else {} + if (par2==true) {} else {}} + + + testcase testcase2() runs on MTC system SystemInterface { + if (par2==true) {} else {}} + + testcase testcase3() runs on MTC system SystemInterface { + if (par3==true) {} else {}} + + testcase testcase4() runs on MTC system SystemInterface {} + + + function function1 () + return boolean { + return par1; + } + + function function2 () + return boolean { + return par2; + } + + function function3 () + return boolean { + return par3; + } + + altstep altstep1(){ + + } + + + testcase testcaseloop1_1() runs on MTC system SystemInterface {function1();} + testcase testcaseloop1_2() runs on MTC system SystemInterface {testcaseloop1_3();testcaseloop1_1()} + testcase testcaseloop1_3() runs on MTC system SystemInterface {testcaseloop1_2();} + +testcase testcasef1() runs on MTC system SystemInterface {function1();} +testcase testcasef2() runs on MTC system SystemInterface {function2();} +testcase testcasef3() runs on MTC system SystemInterface {function3();} + +testcase testcase_test() runs on MTC system SystemInterface{function_indirect1(par2)}; +function function_indirect2(boolean par){}; + + +testcase testcasetcf1() runs on MTC system SystemInterface {testcasef1();} + +} Index: /trunk/t3d-examples/t3dtest/undocumentedParameters.ttcn3 =================================================================== --- /trunk/t3d-examples/t3dtest/undocumentedParameters.ttcn3 (revision 7) +++ /trunk/t3d-examples/t3dtest/undocumentedParameters.ttcn3 (revision 7) @@ -0,0 +1,12 @@ +module undocumentedParameters { + + +// * @param newparam1 paramdescription +// * @param newparam5 paramdescription +// * @param newparam3 paramdescription +import from module_with_moduleParameters recursive all; + function f_test2 (inout StringStack newparam1, in charstring newparam2, in charstring newparam3, in charstring newparam4) runs on floor return integer{ + p_stack.stringItems[p_stack.stackSize] := p_item; + p_stack.stackSize := p_stack.stackSize + 1; + } +} Index: /trunk/t3d/.classpath =================================================================== --- /trunk/t3d/.classpath (revision 7) +++ /trunk/t3d/.classpath (revision 7) @@ -0,0 +1,29 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Index: /trunk/t3d/.project =================================================================== --- /trunk/t3d/.project (revision 7) +++ /trunk/t3d/.project (revision 7) @@ -0,0 +1,17 @@ + + + t3d + + + + + + org.eclipse.jdt.core.javabuilder + + + + + + org.eclipse.jdt.core.javanature + + Index: /trunk/t3d/build.xml =================================================================== --- /trunk/t3d/build.xml (revision 7) +++ /trunk/t3d/build.xml (revision 7) @@ -0,0 +1,55 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Building T3D Distribution in ${dist}... + + + + + + + + + + + + + + + + + + + + + + + Index: /trunk/t3d/css/doc.css =================================================================== --- /trunk/t3d/css/doc.css (revision 7) +++ /trunk/t3d/css/doc.css (revision 7) @@ -0,0 +1,374 @@ +/* +Navigation bar: + div_views: contains list of all views and possible toggling options + div_modules: contains list of TTCN3 modules + div_index: contains list of TTCN3 elements + +p_header: contains path navigation + +div_content: contains page content + div_element: contains source code of element in Main View + div_comment: contains information from T3D comments + div_statistics: contains statistics in index.html + div_import: contains import table in Import View + div_mp: contains tables in ModuleParameter/Testcase View +*/ +@media screen{ +body{ + background:#FFFFFF; + font-family: Arial, Helvetica; + color:#000000; + margin:0; + border:0; + padding:0; + height:100%; + max-height:100%; + overflow: auto; +} + +#div_modules, #div_index, #div_content{ + overflow:auto; +} + +#div_views, #div_index, #div_modules{ + background-color:#F3F3E7 !important; + padding-left:10px; + font-size:12px; +} + +#div_element, #div_comment, #div_import, #div_mp, #div_statistics{ + font-size:12px; +} + +#div_content{ + border:1px solid #000000; + background-color:#FFFFFF; + position:fixed; + top:60px; + left:25%; + right:1%; + bottom:40px; + overflow:auto; + padding:2px; +} + + +#div_import, #div_mp, #div_statistics, #div_comment, #div_element, #div_statistics{ + border-top:1px solid #000000; + border-bottom:1px solid #000000; +} + +#div_import, #div_mp, #div_statistics{ + background-color:#F3F3E7 !important; +} + +#div_views{ + border:1px solid #000000; + position:fixed; + top:10px; + left:1%; + bottom:40px; + width:22%; + overflow:auto; + +} + +#div_modules{ + border:1px solid #000000; + position:fixed; + top:100px; + left:1%; + bottom:60%; + width:22%; + overflow:auto; +} + +#div_index{ + border:1px solid #000000; + position:fixed; + top:40%; + left:1%; + bottom:40px; + width:22%; + overflow:auto; +} + +#div_comment, #div_element, #div_statistics{ + background-color:#F3F3E7; + padding:15px; + padding-top:0px; + padding-bottom:0px; + margin-bottom:20px; +} + +#p_header a { + color:#AAA; +} + +#p_header a:hover { + color:#FFF; +} + +#p_t3dversion{ + right:1%; + position:absolute; + bottom:1px; + text-align:right; + font-size:10px; +} + +#path{ + font-size:10px; +} + +#p_header{ + border:1px solid #000000; + font-size:15px; + position:absolute; + top:10px; + left:25%; + right:1%; + height:30px; + overflow:hidden; + margin:0px; + padding:10px; + background:#53829d; + color:#FFFFFF; +} +} +/* Not YET Used */ +#header { + position:absolute; + top:0; + left:0; + width:100%; + height:120px; + overflow:auto; + background:#53829d; + color:#fff; + } + +/* Not YET Used */ +#footer { + position:absolute; + bottom:0; + left:0; + width:100%; + height:50px; + overflow:auto; + text-align:right; + background:#73a2bd; +} + +.td_commenttype{ + vertical-align:top; +} + +table +{ + border-collapse:collapse; +} + +table, td, th +{ + border:1px solid black; +} + +#table_statistics{ + margin-top:20px; + margin-left: auto; + margin-right: auto; +} + +.import_grey a{ + color:#777777 !important; +} + +.td_table_statistics_left{ + text-align:right; + padding-right:5px; +} + +.td_table_statistics_mid{ + text-align:center; + padding-right:5px; +} + +.td_table_statistics_right{ + text-align:left; + padding-left:5px; +} + +#div_statistics th{ + width:30%; + border-bottom:none !important; +} + +#div_statistics td{ + text-align:center; +} + +.td_table_statistics_modules{ + text-align:left !important; +} + +#div_element{ + font-family:monospace; +} + +a:link, a:active, a:hover, a:visited{ + color:#333377; + text-decoration:none; +} + +#div_element a{ + color:blue; +} + +#div_element a:hover{ + color:red; + text-decoration:underline; +} + +#table_import td{ + vertical-align:top; + width:33%; + padding-left:10px; +} + +#table_import{ + width:100%; +} + + + + +#table_import_modules{ + border-left:1px solid #000000; + border-right:1px solid #000000; +} + +.div_group_behaviour{ + padding-left:50px; +} + +.comment_line{ + padding-right:50px; +} + +.span_tagtype, .span_tagtypeOrig{ + font-weight:bold; +} + +.bold{ + font-weight:bold; +} + +#head_name{ + color:#0000FF; + font-weight:bold; +} + +.comment{ + background-color:#DDDDDD; + padding:5px; +} + +.elementName{ + background-color:#BBBBFF; + padding-left:5px; +} +/* +importedby, importedby_ind, selected, imports, imports: determine colors of modules in Import View +*/ +.importedby{ + color:#f86503 !important; +} + +.importedby_ind{ + color:#FF0000 !important; +} + +.selected{ + color:#000000 !important; +} + +.imports{ + color:#278e57 !important; +} + +.imports_ind{ + color:#00FF00 !important; +} + + +/* spans (toggle) notes */ +.span_showhidenote{ + font-size: 5pt; + bottom: 0.5em; +} + +.padding_left_10px{ + padding-left:10px; + border:none !important; +} + +.padding_left_10px tr td{ + border:none !important; +} + + +.padding_left_20px{ + padding-left:20px; +} +/* contains source code */ +pre { + white-space: pre-wrap; +} +/*spans highlighted TTCN3 keywords*/ +.syntax{ + font-weight:bold !important; +} + +@media print{ + +body{ + background:#FFFFFF; + font-family: Arial, Helvetica; + color:#000000; + margin:0; + border:0; + padding:0; + height:100%; + max-height:100%; +} + +div{ + margin-left:6px !important; +} +#div_views, #div_index, #div_modules { + display:none !important; +} + +#div_comment{ + border-bottom:1px solid #000000; +} + +p, pre, span, a, div{ + color:#000000 !important;background-color:#FFFFFF !important;font-size:12px !important; +} +#div_content, #p_header{ + left:0px !important; width:615px !important; border:none !important; height:auto !important; +} + +#div_element pre{ + border:0.5px dotted black !important; +} + + +#p_t3dversion{ + text-align:right; + font-size:10px; +} + +} Index: /trunk/t3d/js/doc.js =================================================================== --- /trunk/t3d/js/doc.js (revision 7) +++ /trunk/t3d/js/doc.js (revision 7) @@ -0,0 +1,127 @@ +var toggled = false; + +var toggled1 = false; +var toggled2 = false; + +function getElementsByClass(searchClass,node,tag) { + var classElements = new Array(); + if ( node == null ) + node = document; + if ( tag == null ) + tag = '*'; + var els = node.getElementsByTagName(tag); + var elsLen = els.length; + var pattern = new RegExp('(^|\\\\s)'+searchClass+'(\\\\s|$)'); + for (i = 0, j = 0; i < elsLen; i++) { + if ( pattern.test(els[i].className) ) { + classElements[j] = els[i]; + j++; + } + } + return classElements; +} + +function toggleConstructbodies(hide){ + if(hide == "true"){ + var x; + var constructBodies = getElementsByClass("span_constructbody"); + + if(toggled) + for(x in constructBodies) + constructBodies[x].style.display=''; + else + for(x in constructBodies) + constructBodies[x].style.display='none'; + toggled = !toggled; + } + if (document.getElementById('modulebody') != null){ + document.getElementById('modulebody').style.display=''; + } +} + +function toggleImportDetails(){ + var x; + var constructBodies = getElementsByClass("span_importdetail"); + + if(toggled) + for(x in constructBodies) + constructBodies[x].style.display=''; + else + for(x in constructBodies) + constructBodies[x].style.display='none'; + toggled = !toggled; +} + +function togglePaths(hide){ + if(hide == "true"){ + var x; + var constructBodies = getElementsByClass("td_path"); + + if(toggled) + for(x in constructBodies) + constructBodies[x].style.display=''; + else + for(x in constructBodies) + constructBodies[x].style.display='none'; + toggled = !toggled; + } +} + +function toggleHideNotes(){ + var x; + var constructBodies = getElementsByClass("span_showhidenote"); + for(x in constructBodies){ + toggleElement(constructBodies[x]); + } +} + +function toggleElement(element){ + if(element.style.display=='none') + element.style.display=''; + else + element.style.display='none'; +} + +function toggle(elementName){ + var element = document.getElementById(elementName); + toggleElement(element); +} + +function mp_init(listName){ + if(listName != 'Group') +// if (document.getElementById('span_groups')!=null) + document.getElementById('span_groups').style.display='none'; + if(listName != 'Testcase') +// if (document.getElementById('span_testcases'!=null)) + document.getElementById('span_testcases').style.display='none'; + if(listName != 'Module Parameter') +// if (document.getElementById('span_parameters')!=null) + document.getElementById('span_module parameters').style.display='none'; +} + +function init(listName){ + toggleHideNotes(); + if(listName != 'Group') + document.getElementById('span_groups').style.display='none'; + if(listName != 'Function') + document.getElementById('span_functions').style.display='none'; + if(listName != 'Type') + document.getElementById('span_types').style.display='none'; + if(listName != 'Signature') + document.getElementById('span_signatures').style.display='none'; + if(listName != 'Testcase') + document.getElementById('span_testcases').style.display='none'; + if(listName != 'Altstep') + document.getElementById('span_altsteps').style.display='none'; + if(listName != 'Template') + document.getElementById('span_templates').style.display='none'; + if(listName != 'Constant') + document.getElementById('span_constants').style.display='none'; + if(listName != 'Module Parameter') + document.getElementById('span_module parameters').style.display='none'; + if(listName != 'External Function') + document.getElementById('span_external functions').style.display='none'; + if(listName != 'External Constant') + document.getElementById('span_external constants').style.display='none'; + +} Index: /trunk/t3d/lib/LICENSE.txt =================================================================== --- /trunk/t3d/lib/LICENSE.txt (revision 7) +++ /trunk/t3d/lib/LICENSE.txt (revision 7) @@ -0,0 +1,202 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. + Index: /trunk/t3d/lib/xpp3-license.txt =================================================================== --- /trunk/t3d/lib/xpp3-license.txt (revision 7) +++ /trunk/t3d/lib/xpp3-license.txt (revision 7) @@ -0,0 +1,46 @@ +Indiana University Extreme! Lab Software License + +Version 1.1.1 + +Copyright (c) 2002 Extreme! Lab, Indiana University. All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions +are met: + +1. Redistributions of source code must retain the above copyright notice, + this list of conditions and the following disclaimer. + +2. Redistributions in binary form must reproduce the above copyright + notice, this list of conditions and the following disclaimer in + the documentation and/or other materials provided with the distribution. + +3. The end-user documentation included with the redistribution, if any, + must include the following acknowledgment: + + "This product includes software developed by the Indiana University + Extreme! Lab (http://www.extreme.indiana.edu/)." + +Alternately, this acknowledgment may appear in the software itself, +if and wherever such third-party acknowledgments normally appear. + +4. The names "Indiana Univeristy" and "Indiana Univeristy Extreme! Lab" +must not be used to endorse or promote products derived from this +software without prior written permission. For written permission, +please contact http://www.extreme.indiana.edu/. + +5. Products derived from this software may not use "Indiana Univeristy" +name nor may "Indiana Univeristy" appear in their name, without prior +written permission of the Indiana University. + +THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESSED OR IMPLIED +WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. +IN NO EVENT SHALL THE AUTHORS, COPYRIGHT HOLDERS OR ITS CONTRIBUTORS +BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR +CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF +SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR +BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, +WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR +OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF +ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Index: /trunk/t3d/lib/xstream-license.txt =================================================================== --- /trunk/t3d/lib/xstream-license.txt (revision 7) +++ /trunk/t3d/lib/xstream-license.txt (revision 7) @@ -0,0 +1,28 @@ +(BSD Style License) + +Copyright (c) 2003-2006, Joe Walnes +Copyright (c) 2006-2007, XStream Committers +All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are met: + +Redistributions of source code must retain the above copyright notice, this list of +conditions and the following disclaimer. Redistributions in binary form must reproduce +the above copyright notice, this list of conditions and the following disclaimer in +the documentation and/or other materials provided with the distribution. + +Neither the name of XStream nor the names of its contributors may be used to endorse +or promote products derived from this software without specific prior written +permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY +EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES +OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT +SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, +INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED +TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR +BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN +CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY +WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH +DAMAGE. Index: /trunk/t3d/nsis/EnvVarUpdate.nsh =================================================================== --- /trunk/t3d/nsis/EnvVarUpdate.nsh (revision 7) +++ /trunk/t3d/nsis/EnvVarUpdate.nsh (revision 7) @@ -0,0 +1,327 @@ +/** + * EnvVarUpdate.nsh + * : Environmental Variables: append, prepend, and remove entries + * + * WARNING: If you use StrFunc.nsh header then include it before this file + * with all required definitions. This is to avoid conflicts + * + * Usage: + * ${EnvVarUpdate} "ResultVar" "EnvVarName" "Action" "RegLoc" "PathString" + * + * Credits: + * Version 1.0 + * * Cal Turney (turnec2) + * * Amir Szekely (KiCHiK) and e-circ for developing the forerunners of this + * function: AddToPath, un.RemoveFromPath, AddToEnvVar, un.RemoveFromEnvVar, + * WriteEnvStr, and un.DeleteEnvStr + * * Diego Pedroso (deguix) for StrTok + * * Kevin English (kenglish_hi) for StrContains + * * Hendri Adriaens (Smile2Me), Diego Pedroso (deguix), and Dan Fuhry + * (dandaman32) for StrReplace + * + * Version 1.1 (compatibility with StrFunc.nsh) + * * techtonik + * + * http://nsis.sourceforge.net/Environmental_Variables:_append%2C_prepend%2C_and_remove_entries + * + */ + + +!ifndef ENVVARUPDATE_FUNCTION +!define ENVVARUPDATE_FUNCTION +!verbose push +!verbose 3 +!include "LogicLib.nsh" +!include "WinMessages.NSH" +!include "StrFunc.nsh" + +; ---- Fix for conflict if StrFunc.nsh is already includes in main file ----------------------- +!macro _IncludeStrFunction StrFuncName + !ifndef ${StrFuncName}_INCLUDED + ${${StrFuncName}} + !endif + !ifndef Un${StrFuncName}_INCLUDED + ${Un${StrFuncName}} + !endif + !define un.${StrFuncName} "${Un${StrFuncName}}" +!macroend + +!insertmacro _IncludeStrFunction StrTok +!insertmacro _IncludeStrFunction StrStr +!insertmacro _IncludeStrFunction StrRep + +; ---------------------------------- Macro Definitions ---------------------------------------- +!macro _EnvVarUpdateConstructor ResultVar EnvVarName Action Regloc PathString + Push "${EnvVarName}" + Push "${Action}" + Push "${RegLoc}" + Push "${PathString}" + Call EnvVarUpdate + Pop "${ResultVar}" +!macroend +!define EnvVarUpdate '!insertmacro "_EnvVarUpdateConstructor"' + +!macro _unEnvVarUpdateConstructor ResultVar EnvVarName Action Regloc PathString + Push "${EnvVarName}" + Push "${Action}" + Push "${RegLoc}" + Push "${PathString}" + Call un.EnvVarUpdate + Pop "${ResultVar}" +!macroend +!define un.EnvVarUpdate '!insertmacro "_unEnvVarUpdateConstructor"' +; ---------------------------------- Macro Definitions end------------------------------------- + +;----------------------------------- EnvVarUpdate start---------------------------------------- +!define hklm_all_users 'HKLM "SYSTEM\CurrentControlSet\Control\Session Manager\Environment"' +!define hkcu_current_user 'HKCU "Environment"' + +!macro EnvVarUpdate UN + +Function ${UN}EnvVarUpdate + + Push $0 + Exch 4 + Exch $1 + Exch 3 + Exch $2 + Exch 2 + Exch $3 + Exch + Exch $4 + Push $5 + Push $6 + Push $7 + Push $8 + Push $9 + Push $R0 + + /* After this point: + ------------------------- + $0 = ResultVar (returned) + $1 = EnvVarName (input) + $2 = Action (input) + $3 = RegLoc (input) + $4 = PathString (input) + $5 = Orig EnvVar (read from registry) + $6 = Len of $0 (temp) + $7 = tempstr1 (temp) + $8 = Entry counter (temp) + $9 = tempstr2 (temp) + $R0 = tempChar (temp) */ + + ; Step 1: Read contents of EnvVarName from RegLoc + ; + ; Check for empty EnvVarName + ${If} $1 == "" + SetErrors + DetailPrint "ERROR: EnvVarName is blank" + Goto EnvVarUpdate_Restore_Vars + ${EndIf} + + ; Check for valid Action + ${If} $2 != "A" + ${AndIf} $2 != "P" + ${AndIf} $2 != "R" + SetErrors + DetailPrint "ERROR: Invalid Action - must be A, P, or R" + Goto EnvVarUpdate_Restore_Vars + ${EndIf} + + ${If} $3 == HKLM + ReadRegStr $5 ${hklm_all_users} $1 ; Get EnvVarName from all users into $5 + ${ElseIf} $3 == HKCU + ReadRegStr $5 ${hkcu_current_user} $1 ; Read EnvVarName from current user into $5 + ${Else} + SetErrors + DetailPrint 'ERROR: Action is [$3] but must be "HKLM" or HKCU"' + Goto EnvVarUpdate_Restore_Vars + ${EndIf} + + ; Check for empty PathString + ${If} $4 == "" + SetErrors + DetailPrint "ERROR: PathString is blank" + Goto EnvVarUpdate_Restore_Vars + ${EndIf} + + ; Make sure we've got some work to do + ${If} $5 == "" + ${AndIf} $2 == "R" + SetErrors + DetailPrint "$1 is empty - Nothing to remove" + Goto EnvVarUpdate_Restore_Vars + ${EndIf} + + ; Step 2: Scrub EnvVar + ; + StrCpy $0 $5 ; Copy the contents to $0 + ; Remove spaces around semicolons (NOTE: spaces before the 1st entry or + ; after the last one are not removed here but instead in Step 3) + ${If} $0 != "" ; If EnvVar is not empty ... + ${Do} + ${${UN}StrStr} $7 $0 " ;" + ${If} $7 == "" + ${ExitDo} + ${EndIf} + ${${UN}StrRep} $0 $0 " ;" ";" ; Remove ';' + ${Loop} + ${Do} + ${${UN}StrStr} $7 $0 "; " + ${If} $7 == "" + ${ExitDo} + ${EndIf} + ${${UN}StrRep} $0 $0 "; " ";" ; Remove ';' + ${Loop} + ${Do} + ${${UN}StrStr} $7 $0 ";;" + ${If} $7 == "" + ${ExitDo} + ${EndIf} + ${${UN}StrRep} $0 $0 ";;" ";" + ${Loop} + + ; Remove a leading or trailing semicolon from EnvVar + StrCpy $7 $0 1 0 + ${If} $7 == ";" + StrCpy $0 $0 "" 1 ; Change ';' to '' + ${EndIf} + StrLen $6 $0 + IntOp $6 $6 - 1 + StrCpy $7 $0 1 $6 + ${If} $7 == ";" + StrCpy $0 $0 $6 ; Change ';' to '' + ${EndIf} + ; DetailPrint "Scrubbed $1: [$0]" ; Uncomment to debug + ${EndIf} + + /* Step 3. Remove all instances of the target path/string (even if "A" or "P") + $6 = bool flag (1 = found and removed PathString) + $7 = a string (e.g. path) delimited by semicolon(s) + $8 = entry counter starting at 0 + $9 = copy of $0 + $R0 = tempChar */ + + ${If} $5 != "" ; If EnvVar is not empty ... + StrCpy $9 $0 + StrCpy $0 "" + StrCpy $8 0 + StrCpy $6 0 + + ${Do} + ${${UN}StrTok} $7 $9 ";" $8 "0" ; $7 = next entry, $8 = entry counter + + ${If} $7 == "" ; If we've run out of entries, + ${ExitDo} ; were done + ${EndIf} ; + + ; Remove leading and trailing spaces from this entry (critical step for Action=Remove) + ${Do} + StrCpy $R0 $7 1 + ${If} $R0 != " " + ${ExitDo} + ${EndIf} + StrCpy $7 $7 "" 1 ; Remove leading space + ${Loop} + ${Do} + StrCpy $R0 $7 1 -1 + ${If} $R0 != " " + ${ExitDo} + ${EndIf} + StrCpy $7 $7 -1 ; Remove trailing space + ${Loop} + ${If} $7 == $4 ; If string matches, remove it by not appending it + StrCpy $6 1 ; Set 'found' flag + ${ElseIf} $7 != $4 ; If string does NOT match + ${AndIf} $0 == "" ; and the 1st string being added to $0, + StrCpy $0 $7 ; copy it to $0 without a prepended semicolon + ${ElseIf} $7 != $4 ; If string does NOT match + ${AndIf} $0 != "" ; and this is NOT the 1st string to be added to $0, + StrCpy $0 $0;$7 ; append path to $0 with a prepended semicolon + ${EndIf} ; + + IntOp $8 $8 + 1 ; Bump counter + ${Loop} ; Check for duplicates until we run out of paths + ${EndIf} + + ; Step 4: Perform the requested Action + ; + ${If} $2 != "R" ; If Append or Prepend + ${If} $6 == 1 ; And if we found the target + DetailPrint "Target is already present in $1. It will be removed and" + ${EndIf} + ${If} $0 == "" ; If EnvVar is (now) empty + StrCpy $0 $4 ; just copy PathString to EnvVar + ${If} $6 == 0 ; If found flag is either 0 + ${OrIf} $6 == "" ; or blank (if EnvVarName is empty) + DetailPrint "$1 was empty and has been updated with the target" + ${EndIf} + ${ElseIf} $2 == "A" ; If Append (and EnvVar is not empty), + StrCpy $0 $0;$4 ; append PathString + ${If} $6 == 1 + DetailPrint "appended to $1" + ${Else} + DetailPrint "Target was appended to $1" + ${EndIf} + ${Else} ; If Prepend (and EnvVar is not empty), + StrCpy $0 $4;$0 ; prepend PathString + ${If} $6 == 1 + DetailPrint "prepended to $1" + ${Else} + DetailPrint "Target was prepended to $1" + ${EndIf} + ${EndIf} + ${Else} ; If Action = Remove + ${If} $6 == 1 ; and we found the target + DetailPrint "Target was found and removed from $1" + ${Else} + DetailPrint "Target was NOT found in $1 (nothing to remove)" + ${EndIf} + ${If} $0 == "" + DetailPrint "$1 is now empty" + ${EndIf} + ${EndIf} + + ; Step 5: Update the registry at RegLoc with the updated EnvVar and announce the change + ; + ClearErrors + ${If} $3 == HKLM + WriteRegExpandStr ${hklm_all_users} $1 $0 ; Write it in all users section + ${ElseIf} $3 == HKCU + WriteRegExpandStr ${hkcu_current_user} $1 $0 ; Write it to current user section + ${EndIf} + + IfErrors 0 +4 + MessageBox MB_OK|MB_ICONEXCLAMATION "Could not write updated $1 to $3" + DetailPrint "Could not write updated $1 to $3" + Goto EnvVarUpdate_Restore_Vars + + ; "Export" our change + SendMessage ${HWND_BROADCAST} ${WM_WININICHANGE} 0 "STR:Environment" /TIMEOUT=5000 + + EnvVarUpdate_Restore_Vars: + ; + ; Restore the user's variables and return ResultVar + Pop $R0 + Pop $9 + Pop $8 + Pop $7 + Pop $6 + Pop $5 + Pop $4 + Pop $3 + Pop $2 + Pop $1 + Push $0 ; Push my $0 (ResultVar) + Exch + Pop $0 ; Restore his $0 + +FunctionEnd + +!macroend ; EnvVarUpdate UN +!insertmacro EnvVarUpdate "" +!insertmacro EnvVarUpdate "un." +;----------------------------------- EnvVarUpdate end---------------------------------------- + +!verbose pop +!endif Index: /trunk/t3d/nsis/WriteEnvStr.nsh =================================================================== --- /trunk/t3d/nsis/WriteEnvStr.nsh (revision 7) +++ /trunk/t3d/nsis/WriteEnvStr.nsh (revision 7) @@ -0,0 +1,148 @@ +!ifndef _WriteEnvStr_nsh +!define _WriteEnvStr_nsh + +!include WinMessages.nsh + +!ifndef WriteEnvStr_RegKey + !ifdef ALL_USERS + !define WriteEnvStr_RegKey \ + 'HKLM "SYSTEM\CurrentControlSet\Control\Session Manager\Environment"' + !else + !define WriteEnvStr_RegKey 'HKCU "Environment"' + !endif +!endif + +# +# WriteEnvStr - Writes an environment variable +# Note: Win9x systems requires reboot +# +# Example: +# Push "HOMEDIR" # name +# Push "C:\New Home Dir\" # value +# Call WriteEnvStr +# +Function WriteEnvStr + Exch $1 ; $1 has environment variable value + Exch + Exch $0 ; $0 has environment variable name + Push $2 + + Call IsNT + Pop $2 + StrCmp $2 1 WriteEnvStr_NT + ; Not on NT + StrCpy $2 $WINDIR 2 ; Copy drive of windows (c:) + FileOpen $2 "$2\autoexec.bat" a + FileSeek $2 0 END + FileWrite $2 "$\r$\nSET $0=$1$\r$\n" + FileClose $2 + SetRebootFlag true + Goto WriteEnvStr_done + + WriteEnvStr_NT: + WriteRegExpandStr ${WriteEnvStr_RegKey} $0 $1 + SendMessage ${HWND_BROADCAST} ${WM_WININICHANGE} \ + 0 "STR:Environment" /TIMEOUT=5000 + + WriteEnvStr_done: + Pop $2 + Pop $0 + Pop $1 +FunctionEnd + +# +# un.DeleteEnvStr - Removes an environment variable +# Note: Win9x systems requires reboot +# +# Example: +# Push "HOMEDIR" # name +# Call un.DeleteEnvStr +# +Function un.DeleteEnvStr + Exch $0 ; $0 now has the name of the variable + Push $1 + Push $2 + Push $3 + Push $4 + Push $5 + + Call un.IsNT + Pop $1 + StrCmp $1 1 DeleteEnvStr_NT + ; Not on NT + StrCpy $1 $WINDIR 2 + FileOpen $1 "$1\autoexec.bat" r + GetTempFileName $4 + FileOpen $2 $4 w + StrCpy $0 "SET $0=" + SetRebootFlag true + + DeleteEnvStr_dosLoop: + FileRead $1 $3 + StrLen $5 $0 + StrCpy $5 $3 $5 + StrCmp $5 $0 DeleteEnvStr_dosLoop + StrCmp $5 "" DeleteEnvStr_dosLoopEnd + FileWrite $2 $3 + Goto DeleteEnvStr_dosLoop + + DeleteEnvStr_dosLoopEnd: + FileClose $2 + FileClose $1 + StrCpy $1 $WINDIR 2 + Delete "$1\autoexec.bat" + CopyFiles /SILENT $4 "$1\autoexec.bat" + Delete $4 + Goto DeleteEnvStr_done + + DeleteEnvStr_NT: + DeleteRegValue ${WriteEnvStr_RegKey} $0 + SendMessage ${HWND_BROADCAST} ${WM_WININICHANGE} \ + 0 "STR:Environment" /TIMEOUT=5000 + + DeleteEnvStr_done: + Pop $5 + Pop $4 + Pop $3 + Pop $2 + Pop $1 + Pop $0 +FunctionEnd + +!ifndef IsNT_KiCHiK +!define IsNT_KiCHiK + +# +# [un.]IsNT - Pushes 1 if running on NT, 0 if not +# +# Example: +# Call IsNT +# Pop $0 +# StrCmp $0 1 +3 +# MessageBox MB_OK "Not running on NT!" +# Goto +2 +# MessageBox MB_OK "Running on NT!" +# +!macro IsNT UN +Function ${UN}IsNT + Push $0 + ReadRegStr $0 HKLM \ + "SOFTWARE\Microsoft\Windows NT\CurrentVersion" CurrentVersion + StrCmp $0 "" 0 IsNT_yes + ; we are not NT. + Pop $0 + Push 0 + Return + + IsNT_yes: + ; NT!!! + Pop $0 + Push 1 +FunctionEnd +!macroend +!insertmacro IsNT "" +!insertmacro IsNT "un." + +!endif ; IsNT_KiCHiK + +!endif ; _WriteEnvStr_nsh Index: /trunk/t3d/nsis/t3d.nsi =================================================================== --- /trunk/t3d/nsis/t3d.nsi (revision 7) +++ /trunk/t3d/nsis/t3d.nsi (revision 7) @@ -0,0 +1,198 @@ +; T3D Installer +;----------------------------------------------------------------------------------------------------------------------------- + +!define PRODUCT_NAME "T3D" +!define AppName "T3D" +!define AppVersion "1.0" +!define ShortName "T3D" +!define Vendor "Software Engineering for Distributed Systems Group, University of G�ttingen" +!define JRE_VERSION "1.6" +!define JRE_URL "http://javadl.sun.com/webapps/download/AutoDL?BundleId=26223" +!define ALL_USERS + +LangString ConfirmUninstall ${LANG_ENGLISH} "All existing \ +files and folders under the $(^Name) installation directory \ +'$INSTDIR' will be removed.$\r$\nThis includes any files and folders \ +that have since been added after the installation of \ +$(^Name).$\r$\n$\r$\nAre you sure you wish to continue?" + +!include "MUI2.nsh" +!include "StrFunc.nsh" +!include "EnvVarUpdate.nsh" +!include "WriteEnvStr.nsh" + +Name "T3D" +OutFile "t3d-install-32bit.exe" + +InstallDir $PROGRAMFILES\ETSI\T3D +InstallDirRegKey HKLM "Software\ETSI\T3D" "Install_Dir" + +RequestExecutionLevel admin + +!define MUI_ABORTWARNING + +!insertmacro MUI_PAGE_COMPONENTS +!insertmacro MUI_PAGE_DIRECTORY +!insertmacro MUI_PAGE_INSTFILES +!insertmacro MUI_UNPAGE_CONFIRM +!insertmacro MUI_UNPAGE_INSTFILES + +!insertmacro MUI_LANGUAGE "English" + +Section "" + Call DetectJRE +SectionEnd + +;----------------------------------------------------------------------------------------------------------------------------- +; The stuff to install +Section "T3D (required)" + SectionIn RO + SetOutPath $INSTDIR + File "..\dist\t3d.bat" + File "..\doc\t3d-documentation.pdf" + SetOutPath $INSTDIR\css + File "..\css\*.css" + SetOutPath $INSTDIR\js + File "..\js\*.js" + SetOutPath $INSTDIR\xsd + File "..\xsd\*.*" + SetOutPath $INSTDIR\xslt + File "..\xslt\*.xsl" + SetOutPath $INSTDIR\lib + File /r "..\dist\lib\*.jar" + SetOutPath $INSTDIR + + ;CreateDirectory $APPDATA\T3D + + WriteRegStr HKLM SOFTWARE\ETSI\T3D "Install_Dir" "$INSTDIR" + + ${EnvVarUpdate} $0 "T3D_HOME" "A" "HKLM" $INSTDIR + ${EnvVarUpdate} $0 "PATH" "A" "HKLM" $INSTDIR + + ReadRegStr $2 HKLM "SOFTWARE\JavaSoft\Java Development Kit\1.6" "JavaHome" + StrCmp $2 "" 0 registerJavaHome + ReadRegStr $2 HKLM "SOFTWARE\JavaSoft\Java Runtime Environment\1.6" "JavaHome" + StrCmp $2 "" 0 registerJavaHome +registerJavaHome: + Push JAVA_HOME + Push $2 + Call WriteEnvStr + + ; Write the uninstall keys for Windows + WriteRegStr HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\${AppName}" "DisplayName" "${AppName}" + WriteRegStr HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\${AppName}" "UninstallString" '"$INSTDIR\uninstall.exe"' + WriteRegDWORD HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\${AppName}" "NoModify" 1 + WriteRegDWORD HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\${AppName}" "NoRepair" 1 + WriteUninstaller "uninstall.exe" +SectionEnd + +Section "T3D Sample Files" + SetOutPath $INSTDIR\samples + + File /r /x ".svn" /x ".project" "..\..\t3d-examples\*.*" +SectionEnd + +;----------------------------------------------------------------------------------------------------------------------------- +; Start Menu Section +Section "Start Menu Shortcuts" + CreateDirectory "$SMPROGRAMS\${AppName}" + CreateShortCut "$SMPROGRAMS\${AppName}\Uninstall.lnk" "$INSTDIR\uninstall.exe" "" "$INSTDIR\uninstall.exe" 0 + CreateShortCut "$SMPROGRAMS\${AppName}\T3D Documentation.lnk" "$INSTDIR\t3d-documentation.pdf" + CreateShortCut "$SMPROGRAMS\${AppName}\T3D Default CSS File.lnk" "$INSTDIR\css\doc.css" + + SetOutPath $INSTDIR\samples + CreateShortCut "$SMPROGRAMS\${AppName}\Samples Folder.lnk" "$INSTDIR\samples" +; CreateShortCut "$SMPROGRAMS\${AppName}\T3D Configuration Directory.lnk" "$APPDATA\T3D\" + CreateShortCut "$SMPROGRAMS\${AppName}\Samples Folder (Command-Line).lnk" "$WINDIR\system32\cmd.exe" +SectionEnd + +;----------------------------------------------------------------------------------------------------------------------------- +; Uninstaller +Section "Uninstall" + ; Remove registry keys + DeleteRegKey HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\${AppName}" + DeleteRegKey HKLM SOFTWARE\ETSI\${AppName} + + MessageBox MB_OKCANCEL|MB_ICONINFORMATION $(ConfirmUninstall) IDOK +2 + Abort + RMDir /r $INSTDIR + + ; Remove shortcuts, if any + Delete "$SMPROGRAMS\${AppName}\*.*" + + ; Remove directories used + RMDir "$SMPROGRAMS\${AppName}" + RMDir "$INSTDIR" + RMDir "$PROGRAMFILES\ETSI" + + ; Remove Environment Variables + ${un.EnvVarUpdate} $0 "PATH" "R" "HKLM" $INSTDIR + Push T3D_HOME + Call un.DeleteEnvStr + Push T3D_HOME + Call un.DeleteEnvStr +SectionEnd + +;----------------------------------------------------------------------------------------------------------------------------- +Function GetJRE + MessageBox MB_OK "${PRODUCT_NAME} uses Java ${JRE_VERSION}, it will now \ + be downloaded and installed" + + StrCpy $2 "$TEMP\Java Runtime Environment.exe" + nsisdl::download /TIMEOUT=30000 ${JRE_URL} $2 + Pop $R0 ;Get the return value + StrCmp $R0 "success" +3 + MessageBox MB_OK "Download failed: $R0" + Quit + ExecWait $2 + Delete $2 +FunctionEnd + +;----------------------------------------------------------------------------------------------------------------------------- +Function DetectJRE + ReadRegStr $2 HKLM "SOFTWARE\JavaSoft\Java Runtime Environment" \ + "CurrentVersion" + StrCmp $2 ${JRE_VERSION} done + + Call GetJRE + + done: +FunctionEnd + +;----------------------------------------------------------------------------------------------------------------------------- +Function .onInstSuccess + MessageBox MB_OK "You have successfully installed ${PRODUCT_NAME}. You can now use 't3d' on the command-line!" +FunctionEnd + +;----------------------------------------------------------------------------------------------------------------------------- +;Function un.onUninstSuccess +; MessageBox MB_OK "You have successfully uninstalled ${PRODUCT_NAME}." +;FunctionEnd + +;----------------------------------------------------------------------------------------------------------------------------- +Function .onInit + ReadRegStr $R0 HKLM \ + "Software\Microsoft\Windows\CurrentVersion\Uninstall\${AppName}" \ + "UninstallString" + StrCmp $R0 "" done + + MessageBox MB_OKCANCEL|MB_ICONEXCLAMATION \ + "${AppName} is already installed. $\n$\nClick `OK` to remove the \ + previous version or `Cancel` to cancel this upgrade." \ + IDOK uninst + Abort + +;Run the uninstaller +uninst: + ClearErrors + ExecWait '$R0 _?=$INSTDIR' ;Do not copy the uninstaller to a temp file + + IfErrors no_remove_uninstaller + ;You can either use Delete /REBOOTOK in the uninstaller or add some code + ;here to remove the uninstaller. Use a registry key to check + ;whether the user has chosen to uninstall. If you are using an uninstaller + ;components page, make sure all sections are uninstalled. + no_remove_uninstaller: + +done: +FunctionEnd Index: /trunk/t3d/src/elements/TTCN3Comment.java =================================================================== --- /trunk/t3d/src/elements/TTCN3Comment.java (revision 7) +++ /trunk/t3d/src/elements/TTCN3Comment.java (revision 7) @@ -0,0 +1,309 @@ +package elements; + +import java.util.LinkedList; +import java.util.regex.Matcher; +import java.util.regex.Pattern; +import org.apache.commons.lang.*; +import org.etsi.t3d.T3D; + +import de.ugoe.cs.swe.trex.core.analyzer.rfparser.LocationAST; +import de.ugoe.cs.swe.trex.core.analyzer.rfparser.TTCN3ParserTokenTypes; + +public class TTCN3Comment { + private String commentsXML; + + + + private LinkedList desc = new LinkedList(); + private LinkedList author = new LinkedList(); + private LinkedList config = new LinkedList(); + private LinkedList exception = new LinkedList(); + private LinkedList member = new LinkedList(); + private LinkedList param = new LinkedList(); + private LinkedList purpose = new LinkedList(); + private LinkedList remark = new LinkedList(); + private LinkedList Return = new LinkedList(); + private LinkedList see = new LinkedList(); + private LinkedList since = new LinkedList(); + private LinkedList status = new LinkedList(); + private LinkedList url = new LinkedList(); + private LinkedList verdict = new LinkedList(); + private LinkedList version = new LinkedList(); + + private LinkedList warnings = new LinkedList(); + private LinkedList seeRefs = new LinkedList(); + + + public TTCN3Comment(LocationAST node){ + + } + + + + //TODO: WHY WHY WHY OH WHY?!?!?!?!?!??! REORGANIZE AND REFACTOR + public TTCN3Comment(String rawComments, int elementType){ + if(rawComments != null && !rawComments.equals("")){ + rawComments = "\n" + rawComments; + rawComments = rawComments.replaceAll("\\r", ""); + rawComments = rawComments.replaceAll("\\n(\\s|\\*|/)*", "\n").replaceAll("\\n+","\n"); + rawComments = rawComments.trim() + "\r___NEWTAG___"; + rawComments = rawComments.replaceAll(" @see", " @esee").replaceAll(" @url", " @eurl"); + rawComments = rawComments.replaceAll("\\n@", "\r___NEWTAG___@"); + + getComments(rawComments, T3D.activeProfile.getCommentTagsConfiguration().getDescTag(), desc); + getComments(rawComments, T3D.activeProfile.getCommentTagsConfiguration().getAuthorTag(), author); + getComments(rawComments, T3D.activeProfile.getCommentTagsConfiguration().getConfigTag(), config); + getComments(rawComments, T3D.activeProfile.getCommentTagsConfiguration().getExceptionTag(), exception); + getComments(rawComments, T3D.activeProfile.getCommentTagsConfiguration().getMemberTag(), member); + getComments(rawComments, T3D.activeProfile.getCommentTagsConfiguration().getParamTag(), param); + getComments(rawComments, T3D.activeProfile.getCommentTagsConfiguration().getPurposeTag(), purpose); + getComments(rawComments, T3D.activeProfile.getCommentTagsConfiguration().getRemarkTag(), remark); + getComments(rawComments, T3D.activeProfile.getCommentTagsConfiguration().getReturnTag(), Return); + getComments(rawComments, T3D.activeProfile.getCommentTagsConfiguration().getSeeTag(), see); + getComments(rawComments, T3D.activeProfile.getCommentTagsConfiguration().getSinceTag(), since); + getComments(rawComments, T3D.activeProfile.getCommentTagsConfiguration().getStatusTag(), status); + getComments(rawComments, T3D.activeProfile.getCommentTagsConfiguration().getUrlTag(), url); + getComments(rawComments, T3D.activeProfile.getCommentTagsConfiguration().getVerdictTag(), verdict); + getComments(rawComments, T3D.activeProfile.getCommentTagsConfiguration().getVersionTag(), version); + + + if (T3D.activeProfile.isCheckConsistentTagUsage()) { + if (config.size() >= 2) + warnings.add(getWarningMultipleTags("@" + T3D.activeProfile.getCommentTagsConfiguration().getConfigTag())); + if (purpose.size() >= 2) + warnings.add(getWarningMultipleTags("@" + T3D.activeProfile.getCommentTagsConfiguration().getPurposeTag())); + if (Return.size() >= 2) + warnings.add(getWarningMultipleTags("@" + T3D.activeProfile.getCommentTagsConfiguration().getReturnTag())); + if (since.size() >= 2) + warnings.add(getWarningMultipleTags("@" + T3D.activeProfile.getCommentTagsConfiguration().getSinceTag())); + if (status.size() >= 2) + warnings.add(getWarningMultipleTags("@" + T3D.activeProfile.getCommentTagsConfiguration().getStatusTag())); + if (version.size() >= 2) + warnings.add(getWarningMultipleTags("@" + T3D.activeProfile.getCommentTagsConfiguration().getVersionTag())); + + if (elementType != TTCN3ParserTokenTypes.TestcaseDef && config.size() >= 1) { + warnings.add(getWarningExtraTags("@" + T3D.activeProfile.getCommentTagsConfiguration().getConfigTag())); + } + if (elementType != TTCN3ParserTokenTypes.SignatureDef && exception.size() >= 1) { + warnings.add(getWarningExtraTags("@" + T3D.activeProfile.getCommentTagsConfiguration().getExceptionTag())); + } + if (elementType != TTCN3ParserTokenTypes.TypeDef + && elementType != TTCN3ParserTokenTypes.TemplateDef + && elementType != TTCN3ParserTokenTypes.ModuleParDef + && elementType != TTCN3ParserTokenTypes.ConstDef + && member.size() >= 1) { + warnings.add(getWarningExtraTags("@" + T3D.activeProfile.getCommentTagsConfiguration().getMemberTag())); + } + if (elementType != TTCN3ParserTokenTypes.TemplateDef + && elementType != TTCN3ParserTokenTypes.SignatureDef + && elementType != TTCN3ParserTokenTypes.FunctionDef + && elementType != TTCN3ParserTokenTypes.AltstepDef + && elementType != TTCN3ParserTokenTypes.TestcaseDef + && param.size() >= 1) { + warnings.add(getWarningExtraTags("@" + T3D.activeProfile.getCommentTagsConfiguration().getParamTag())); + } + if (elementType != TTCN3ParserTokenTypes.TestcaseDef && purpose.size() >= 1) { + warnings.add(getWarningExtraTags("@" + T3D.activeProfile.getCommentTagsConfiguration().getPurposeTag())); + } + if (elementType != TTCN3ParserTokenTypes.FunctionDef && elementType != TTCN3ParserTokenTypes.SignatureDef && Return.size() >= 1) { + warnings.add(getWarningExtraTags("@" + T3D.activeProfile.getCommentTagsConfiguration().getReturnTag())); + } + if (elementType != TTCN3ParserTokenTypes.FunctionDef + && elementType != TTCN3ParserTokenTypes.TestcaseDef + && elementType != TTCN3ParserTokenTypes.AltstepDef + && verdict.size() >= 1) { + warnings.add(getWarningExtraTags("@" + T3D.activeProfile.getCommentTagsConfiguration().getVerdictTag())); + } + + for (String d : desc) + if (d.length() <= 0) + warnings.add(getWarningEmptyTags("@" + T3D.activeProfile.getCommentTagsConfiguration().getDescTag())); + for (String d : author) + if (d.length() <= 0) + warnings.add(getWarningEmptyTags("@" + T3D.activeProfile.getCommentTagsConfiguration().getAuthorTag())); + for (String d : config) + if (d.length() <= 0) + warnings.add(getWarningEmptyTags("@" + T3D.activeProfile.getCommentTagsConfiguration().getConfigTag())); + for (String d : exception) + if (d.length() <= 0) + warnings.add(getWarningEmptyTags("@" + T3D.activeProfile.getCommentTagsConfiguration().getExceptionTag())); + for (String d : member) + if (d.length() <= 0) + warnings.add(getWarningEmptyTags("@" + T3D.activeProfile.getCommentTagsConfiguration().getMemberTag())); + for (String d : param) + if (d.length() <= 0) + warnings.add(getWarningEmptyTags("@" + T3D.activeProfile.getCommentTagsConfiguration().getParamTag())); + for (String d : purpose) + if (d.length() <= 0) + warnings.add(getWarningEmptyTags("@" + T3D.activeProfile.getCommentTagsConfiguration().getPurposeTag())); + for (String d : remark) + if (d.length() <= 0) + warnings.add(getWarningEmptyTags("@" + T3D.activeProfile.getCommentTagsConfiguration().getRemarkTag())); + for (String d : Return) + if (d.length() <= 0) + warnings.add(getWarningEmptyTags("@" + T3D.activeProfile.getCommentTagsConfiguration().getReturnTag())); + for (String d : see) + if (d.length() <= 0) + warnings.add(getWarningEmptyTags("@" + T3D.activeProfile.getCommentTagsConfiguration().getSeeTag())); + for (String d : since) + if (d.length() <= 0) + warnings.add(getWarningEmptyTags("@" + T3D.activeProfile.getCommentTagsConfiguration().getSinceTag())); + for (String d : status) + if (d.length() <= 0) + warnings.add(getWarningEmptyTags("@" + T3D.activeProfile.getCommentTagsConfiguration().getStatusTag())); + for (String d : url) + if (d.length() <= 0) + warnings.add(getWarningEmptyTags("@" + T3D.activeProfile.getCommentTagsConfiguration().getUrlTag())); + for (String d : verdict) + if (d.length() <= 0) + warnings.add(getWarningEmptyTags("@" + T3D.activeProfile.getCommentTagsConfiguration().getVerdictTag())); + for (String d : version) + if (d.length() <= 0) + warnings.add(getWarningEmptyTags("@" + T3D.activeProfile.getCommentTagsConfiguration().getVersionTag())); + } + } + + for(String seeRef : see) + seeRefs.add(seeRef); + } + + private String getWarningMultipleTags(String tagname){ + return "Multiple " + tagname + " tags found (may only contain one)"; + } + + private String getWarningExtraTags(String tagname){ + return tagname + " tag found (may not be used here)"; + } + + private String getWarningEmptyTags(String tagname){ + return "Empty tag found: " + tagname; + } + + + private String getIdentifier(String comment, int pos){ + String subString = comment.substring(pos, comment.length()); + + int endpos = subString.indexOf(" "); + if(endpos == -1) + endpos = subString.length(); +// System.out.println("-" + subString.substring(0, endpos) + "-"); + return subString.substring(0, endpos).trim(); + } + + private String replaceTag(String c, String tag){ + int pos; + c += " "; + while(c.contains(" @" + tag + " ")){ + pos = c.indexOf(" @" + tag + " "); + if(pos != -1){ + String identifier = getIdentifier(c, pos+ (tag.length() + 3)); + c = c.replaceAll("@" + tag + " " + identifier + " ", "<" + tag + ">" + identifier + ""); + }else + break; + } + return c.trim(); + } + + private String replaceSee(String c){ + return replaceTag(c, "esee"); + } + + private String replaceUrl(String c){ + return replaceTag(c, "eurl"); + } + + private String formatComment(String c){ + return StringEscapeUtils.escapeXml(c).replaceAll(" ", " ").replaceAll("\n", " ").replaceAll("\t", " ").replaceAll("\r", ""); + + } + + public String toString(){ + commentsXML = ""; + if(!isEmpty()){ + commentsXML += "\n"; + for(String d : desc) + commentsXML += ("\n" + replaceUrl(replaceSee(formatComment(d))) + ""); + + for(String d : author) + commentsXML += ("\n" + replaceUrl(replaceSee(formatComment(d))) + ""); + + for(String d : config) + commentsXML += ("\n" + replaceUrl(replaceSee(formatComment(d))) + ""); + + for(String d : exception) + commentsXML += ("\n" + replaceUrl(replaceSee(formatComment(d))) + ""); + + for(String d : member) + commentsXML += ("\n" + replaceUrl(replaceSee(formatComment(d))) + ""); + + for(String d : param) + commentsXML += ("\n" + replaceUrl(replaceSee(formatComment(d))) + ""); + for(String d : purpose) + commentsXML += ("\n" + replaceUrl(replaceSee(formatComment(d))) + ""); + + for(String d : remark) + commentsXML += ("\n" + replaceUrl(replaceSee(formatComment(d))) + ""); + + for(String d : Return) + commentsXML += ("\n" + replaceUrl(replaceSee(formatComment(d))) + ""); + + for(String d : see) + commentsXML += ("\n" + formatComment(d) + ""); + + for(String d : since) + commentsXML += ("\n" + replaceUrl(replaceSee(formatComment(d))) + ""); + + for(String d : status) + commentsXML += ("\n" + replaceUrl(replaceSee(formatComment(d))) + ""); + + for(String d : url) + commentsXML += ("\n" + formatComment(d) + ""); + + for(String d : verdict) + commentsXML += ("\n" + replaceUrl(replaceSee(formatComment(d))) + ""); + + for(String d : version) + commentsXML += ("\n" + replaceUrl(replaceSee(formatComment(d))) + ""); + + commentsXML += ""; + + } + if(commentsXML.length() > 20) + return commentsXML; + else + return ""; + } + + private boolean isEmpty(){ + return false; + } + + private void getComments(String commentblock, String tag, LinkedList vector){ + Pattern p = Pattern.compile("@" + tag + "(.|\\n)*\\r___NEWTAG___"); + Matcher m = p.matcher(commentblock); + while (m.find() == true){ + String comment = m.group().replaceFirst("@"+tag, "").replaceFirst("\r___NEWTAG___", "").trim(); + vector.add(comment); + } + } + + public LinkedList getDocumentedParameters(){ + LinkedList docParNames = new LinkedList(); + for(String parString : param){ + if(parString.indexOf(" ") > 0) + docParNames.add(parString.substring(0, parString.indexOf(" "))); + } + return docParNames; + } + + public LinkedList getDescriptions(){ + LinkedList descriptions = new LinkedList(); + for(String descString : desc) + descriptions.add(descString); + return descriptions; + } + + public LinkedList getWarnings() { + return warnings; + } +} Index: /trunk/t3d/src/elements/TTCN3Element.java =================================================================== --- /trunk/t3d/src/elements/TTCN3Element.java (revision 7) +++ /trunk/t3d/src/elements/TTCN3Element.java (revision 7) @@ -0,0 +1,127 @@ +package elements; + +import java.util.LinkedList; + +import org.etsi.common.logging.LoggingInterface.MessageClass; +import org.etsi.t3d.T3D; + + +public class TTCN3Element{ + + private String type; + private int LEVEL0 = 0; + protected String behaviour; + protected TTCN3Comment comment = null; + protected String name = ""; + protected String location = ""; + protected String paramView = ""; + protected String refs = ""; + protected String path = ""; + private LinkedList descs = new LinkedList(); + + public TTCN3Element() { + + } + + //TODO: using type codes will be presumably preferable + //TODO: HELP!!! THIS IS A DISASTER!!!!! REORGANIZE AND REFACTOR + public TTCN3Element(String name, String type, String location, + String behaviour, TTCN3Comment comment, + LinkedList parNames, String filename, String paramView, String path, int line){ + this.name = name; + this.location = location; + this.behaviour = behaviour; + this.comment = comment; + this.type = type; + this.paramView = paramView; + this.path = path; + + + + for(String warning : comment.getWarnings()) { + +// TODO: revise XML usage +// T3D.printLog(LEVEL0, filename, line, line, 1, warning); + T3D.getLoggingInterface().logWarning(line, line, MessageClass.DOCUMENTATION, warning); + } + + LinkedList descsStrings = comment.getDescriptions(); + for(String descString : descsStrings){ + String[] descArray = {descString, filename, "" + line}; + descs.add(descArray); + } + + + + LinkedList docParNames = comment.getDocumentedParameters(); + + + LinkedList unDocParNames = new LinkedList(); + LinkedList docUnparNames = new LinkedList(); + if(!parNames.isEmpty() && T3D.activeProfile.isCheckUndocumentedParameters()){ + for(String parString : parNames){ + boolean isDocumented = false; + for(String docParString : docParNames){ + if(parString.startsWith(docParString + " ")) + isDocumented = true; + } + if(!isDocumented) + unDocParNames.add(parString); + } + + + for(String docParString : docParNames){ + boolean isParameter = false; + for(String parString : parNames){ + if(parString.startsWith(docParString + " ")) + isParameter = true; + } + if(!isParameter) + docUnparNames.add(docParString); + } + + for(String s : unDocParNames){ + String parName = s.substring(0, s.indexOf(' ')); + Integer parLine = Integer.valueOf(s.substring(s.indexOf(' ')+1)).intValue(); + String warning = "Undocumented parameter found: " + parName ; +// TODO: review XML usage +// T3D.printLog(LEVEL0, filename, parLine, parLine, 1, warning); + T3D.getLoggingInterface().logWarning(parLine, parLine, MessageClass.DOCUMENTATION, warning); + } + + for(String s : docUnparNames){ + String warning = "Documented parameter not found: " + s ; + //TODO: review XML usage +// T3D.printLog(LEVEL0, filename, line, line, 1, warning); + T3D.getLoggingInterface().logWarning(line, line, MessageClass.DOCUMENTATION, warning); + + } + } + } + + public String toXML(String currentModule){ + return "\n" + + "" + name + "\n" + + "" + location + "\n" + + comment.toString() + + "" + behaviour.replaceAll("", " ") + "" + + "" + currentModule + "" + + paramView + + refs + + path + + ""; + } + + public String getType(){ + return type; + } + public LinkedList getDescs() { + return descs; + } + public String getName(){ + return name; + } + public String getLocation(){ + return location; + } +} Index: /trunk/t3d/src/org/etsi/t3d/DependencyPrinter.java =================================================================== --- /trunk/t3d/src/org/etsi/t3d/DependencyPrinter.java (revision 7) +++ /trunk/t3d/src/org/etsi/t3d/DependencyPrinter.java (revision 7) @@ -0,0 +1,78 @@ +package org.etsi.t3d; + +import java.io.FileNotFoundException; +import java.io.FileOutputStream; +import java.io.PrintStream; + +import de.ugoe.cs.swe.trex.core.analyzer.rfparser.LocationAST; + +public class DependencyPrinter { + private PrintStream stream; + private String currentTTCN3File; + + public void finishXML(){ + writeStream("\n"); + + } + + public void newElement(String name, String id, int type, int line, + String module, String dependencies) { + writeStream("\n\t"); + writeStream(dependencies); + writeStream("\n\t\n"); + } + + public void newGroup(String name, String id, int type, int line, String module, + String elementList) { + writeStream("\n\t"); + writeStream(elementList); + writeStream("\n\t\n"); + } + + public void setXMLPath(String xmlpath){ + FileOutputStream file; + try { + file = new FileOutputStream(xmlpath); + stream = new PrintStream(file); + } catch (FileNotFoundException e) { + e.printStackTrace(); + } + writeStream("\n"); + } + + private void writeStream(String content){ + stream.print(content); + } + + public void setCurrentTTCN3File(String currentTTCN3File) { + this.currentTTCN3File = currentTTCN3File; + } + + public String getCurrentTTCN3File() { + return currentTTCN3File; + } +} Index: /trunk/t3d/src/org/etsi/t3d/ImportPrinter.java =================================================================== --- /trunk/t3d/src/org/etsi/t3d/ImportPrinter.java (revision 7) +++ /trunk/t3d/src/org/etsi/t3d/ImportPrinter.java (revision 7) @@ -0,0 +1,175 @@ +package org.etsi.t3d; + +import java.io.FileNotFoundException; +import java.io.FileOutputStream; +import java.io.PrintStream; +import java.util.LinkedList; + +import org.apache.commons.lang.StringEscapeUtils; +import org.etsi.common.logging.LoggingInterface; +import org.etsi.common.logging.LoggingInterface.MessageClass; +import org.etsi.t3d.visitor.VisitorCommonFunctions; + +import de.ugoe.cs.swe.trex.core.analyzer.rfparser.ASTUtil; +import de.ugoe.cs.swe.trex.core.analyzer.rfparser.LocationAST; +import de.ugoe.cs.swe.trex.core.analyzer.rfparser.TTCN3ParserTokenTypes; + +public class ImportPrinter { + private PrintStream stream; + private boolean firstModule = true; + private LinkedList modules = new LinkedList(); + private LinkedList locationsGlobal = new LinkedList(); + private String currentTTCN3File; + private LoggingInterface logger = null; + + public ImportPrinter() { + this.logger = new LoggingInterface(T3D.activeProfile.getLoggingConfiguration()); + this.logger.setMaximumLogLevel(T3D.getLogLevel()); + } + + public void finishXML(){ + writeStream("\n\n"); + } + + public void setXMLPath(String xmlpath){ + FileOutputStream file; + try { + file = new FileOutputStream(xmlpath); + stream = new PrintStream(file); + } catch (FileNotFoundException e) { + e.printStackTrace(); + } + writeStream("\n"); + } + + private void writeStream(String content){ + stream.print(content); + } + + public void setCurrentTTCN3File(String currentTTCN3File) { + this.currentTTCN3File = currentTTCN3File; + } + + public String getCurrentTTCN3File() { + return currentTTCN3File; + } + + public void printImportView(LocationAST node){ + LinkedList ImportDefs = ASTUtil.findTypeNodes(node, TTCN3ParserTokenTypes.ImportDef); + for(LocationAST importDef : ImportDefs){ + LocationAST importModuleIdentifier = importDef; + while(importModuleIdentifier.getFirstChild() != null) + importModuleIdentifier = importModuleIdentifier.getFirstChild(); + LocationAST importedModuleIdentifier = VisitorCommonFunctions.getDeclarationNodeFromIdentifier(importModuleIdentifier); + + if(!locationsGlobal.contains(importModuleIdentifier.getText())){ + listAdd(locationsGlobal,VisitorCommonFunctions.getName(node.getFirstChild())); + + String behaviour = getImportBehavior(importDef); + + writeStream("\n" + + "\n\t\t" + behaviour + "\n\t\t"); + if(!ASTUtil.findTypeNodes(importDef, TTCN3ParserTokenTypes.AllKeyword).isEmpty()){ + listAdd(locationsGlobal, importModuleIdentifier.getText()); + if(importedModuleIdentifier != null) + printImportView(VisitorCommonFunctions.getModule(importedModuleIdentifier)); + } + + writeStream("\n"); + } else{ + String behaviour = getImportBehavior(importDef); + writeStream("\n" + + "\n\t\t" + behaviour + "\n\t\t\n"); + } + } + } + + private String getImportBehavior(LocationAST importDef){ + String b = VisitorCommonFunctions.getWholeElement(importDef, true).replaceAll("\\r", ""); + b = StringEscapeUtils.escapeXml(b); + b = b.replaceAll("\\n", "").trim(); + if(b.indexOf('{') > 0 && b.indexOf('}') > b.indexOf('{')) + b = b.substring(b.indexOf('{') + 1, b.indexOf('}')); + else + b = b.replaceFirst("import from \\w* ", ""); + b = VisitorCommonFunctions.replaceReferences(b, VisitorCommonFunctions.getReferences(importDef)); + return b.trim(); + } + + private void listAdd(LinkedList list, String string){ + if(!list.contains(string)) + list.add(string); + } + + public void checkForCyclicImports(LocationAST node, LinkedList locations){ + LinkedList ImportDefs = ASTUtil.findTypeNodes(node, TTCN3ParserTokenTypes.ImportDef); + for(LocationAST importDef : ImportDefs){ + LocationAST importModuleIdentifier = importDef; + while(importModuleIdentifier.getFirstChild() != null) + importModuleIdentifier = importModuleIdentifier.getFirstChild(); + LocationAST importedModuleIdentifier = VisitorCommonFunctions.getDeclarationNodeFromIdentifier(importModuleIdentifier); + if(!locations.contains(importModuleIdentifier.getText())){ + LinkedList newLocations = new LinkedList(); + for(String l : locations) + newLocations.add(l); + listAdd(newLocations, VisitorCommonFunctions.getName(node.getFirstChild())); + listAdd(newLocations, importModuleIdentifier.getText()); + + + String behaviour = VisitorCommonFunctions.getBehaviour(importDef, 0, false, true); + + behaviour = behaviour.substring(behaviour.indexOf("") + 7).trim(); + if(behaviour.charAt(0) == '{' && behaviour.charAt(behaviour.length()-1) == '}') + behaviour = behaviour.substring(1, behaviour.length()-1); + + behaviour = behaviour.replaceAll("\\s;", "").replaceAll("", "").replaceAll("", "");; + + behaviour = behaviour.trim(); + if(behaviour.charAt(0) == '{') + behaviour = behaviour.replaceAll("\\{", "").replaceAll("\\}", ""); + behaviour = behaviour.replaceAll("\\n", ""); + + if(behaviour.startsWith("all") || behaviour.startsWith("recursive all")) + checkForCyclicImports(VisitorCommonFunctions.getModule(importedModuleIdentifier), newLocations); + } else if(locations.getFirst().equals(importModuleIdentifier.getText())){ + String warning = ""; + for(String l : locations) { + warning += " -> " + l; + } + warning = "Cyclic imports found: " + warning.substring(4) + " -> " + locations.getFirst(); + this.getLoggingInterface().logWarning(importModuleIdentifier.getLine(), + importModuleIdentifier.getLine(), + MessageClass.DOCUMENTATION, + warning); + //TODO: revise XML usage + //T3D.printLog(0, currentTTCN3File, importModuleIdentifier.getLine(), importModuleIdentifier.getLine(), 1, warning); + } + } + } + + public void newModule(String name) { + locationsGlobal = new LinkedList(); + String moduleName = name; + if (modules.contains(name)) { + int repetitionIndex = 0; + while(modules.contains(name + "-"+repetitionIndex)){ + repetitionIndex++; + } + moduleName = name + "-" + repetitionIndex; + } + modules.add(moduleName); + if(!firstModule) + writeStream("\n"); + else + firstModule = false; + writeStream("\n"); + } + + public void setLoggingInterface(LoggingInterface logger) { + this.logger = logger; + } + + public LoggingInterface getLoggingInterface() { + return logger; + } +} Index: /trunk/t3d/src/org/etsi/t3d/T3D.java =================================================================== --- /trunk/t3d/src/org/etsi/t3d/T3D.java (revision 7) +++ /trunk/t3d/src/org/etsi/t3d/T3D.java (revision 7) @@ -0,0 +1,838 @@ +package org.etsi.t3d; + + +import java.io.File; +import java.io.FileNotFoundException; +import java.io.FileOutputStream; +import java.io.IOException; +import java.util.ArrayList; +import java.util.Comparator; +import java.util.HashMap; +import java.util.List; + +import javax.xml.parsers.DocumentBuilderFactory; +import javax.xml.parsers.ParserConfigurationException; +import javax.xml.transform.Transformer; +import javax.xml.transform.TransformerConfigurationException; +import javax.xml.transform.TransformerException; +import javax.xml.transform.TransformerFactory; +import javax.xml.transform.stream.StreamResult; +import javax.xml.transform.stream.StreamSource; + +import org.apache.commons.cli.CommandLine; +import org.apache.commons.cli.CommandLineParser; +import org.apache.commons.cli.GnuParser; +import org.apache.commons.cli.HelpFormatter; +import org.apache.commons.cli.Option; +import org.apache.commons.cli.ParseException; +import org.etsi.t3d.config.T3DConfig; +import org.etsi.t3d.config.DocumentationProfile; +import org.etsi.t3d.config.T3DOptionsHandler; +import org.etsi.t3d.exceptions.TTCN3BehaviorException; +import org.etsi.t3d.exceptions.TTCN3ParserException; +import org.etsi.t3d.visitor.DependencyVisitor; +import org.etsi.t3d.visitor.ImportVisitor; +import org.etsi.t3d.visitor.T3DVisitor; +import org.etsi.common.InputInterface; +import org.etsi.common.MiscTools; +import org.etsi.common.configuration.ConfigTools; +import org.etsi.common.exceptions.TerminationException; +import org.etsi.common.logging.LoggingInterface; +import org.etsi.common.logging.LoggingInterface.LogLevel; +import org.xml.sax.SAXException; + +import antlr.MismatchedTokenException; +import antlr.RecognitionException; +import antlr.TokenStreamException; +import de.ugoe.cs.swe.trex.core.analyzer.rfparser.LocationAST; +import de.ugoe.cs.swe.trex.core.analyzer.rfparser.TTCN3Analyzer; +import de.ugoe.cs.swe.trex.core.analyzer.rfparser.TTCN3AnalyzerFlyweightFactory; +import de.ugoe.cs.swe.trex.core.analyzer.rfparser.TTCN3Parser; + +public class T3D { + + public static String versionNumber = "v1.0.2"; + //set during automated server builds + private static String buildStamp = "---BUILD_STAMP---"; + public static DocumentationProfile activeProfile = null; + private String configurationClassName = T3DConfig.class.getName(); + private String configurationProfileClassName = DocumentationProfile.class.getName(); + private String configurationFilename; + private String selectedProfileName = null; + private static LogLevel logLevel = LogLevel.INFORMATION; + + private HashMap argsMap = new HashMap(); + private ArrayList inputPaths = new ArrayList(); + private String destinationPath = null; + + private HashMap linesOfCodeMap = new HashMap(); + private int totalLoc = 0; + + private boolean generateNewConfiguration = false; + + private static boolean generateMainXML = false; + private static boolean generateDependenciesXML = false; + private static boolean generateHTML = false; + + private static XMLPrinter xmlPrinter; + private static ImportPrinter importPrinter; + private static DependencyPrinter depPrinter; + //TODO: START HERE, remove and substitute by a method that derives the names based on the TTCN3ParserTokenTypes + //WHAT ABOUT EXTERNAL FUNCTIONS??? + //public final static String elementTypes[] = {"Module", "Function", "Testcase", "Group", "Altstep", "Constant", "Module Parameter", "Template", "Type", "Signature"}; + private static final String documentationLogFile = "log.xml"; + private static final String documentationXmlFile = "project.xml"; + private static final String dependencyXmlFile = "dependencies.xml"; + private static final String importXmlFile = "imports.xml"; + private String xsdFile = System.getenv("T3D_HOME")+"/xsd/project_schema.xsd"; + + //private static T3DLoggingInterface loggingInterface = new T3DLoggingInterface(); + + //TODO: TEMPORARY SOLUTION UNTIL MAJOR OTHER ISSUES ARE RESOLVED + private static LoggingInterface logger = null; + + public T3D() { + } + +// public static void printLog(int LEVEL, String filename, int startLine, int endLine, int type, String output){ +// loggingInterface.printLog(LEVEL, filename, startLine, endLine, type, output); +// } + + // -------------------------------------------------------------------------- + + public void showHelp() { + System.out.println("\nHelp:"); +// System.out.println(" t3d[.bat] [options] (path | filename)+"); +// System.out.println(""); +// System.out.println(" Options (specify in any order): "); +// System.out.println(" --help - prints this screen"); +// System.out.println(" --profile [profilename] - allows manual profile selection, overriding the selected default profile"); +// System.out.println(""); + HelpFormatter formatter = new HelpFormatter(); + formatter.setOptionComparator(new Comparator

Module Parameter	Path
-	-
+ +