JENKINS-30000 (Refactor TI parser)

jenkinsci · Aug 18, 2015 · c5f48d0 · c5f48d0
1 parent 5eeaed1
commit c5f48d0
Show file tree

Hide file tree

Showing 3 changed files with 178 additions and 6 deletions.
diff --git a/src/main/java/net/praqma/jenkins/memorymap/MemoryMapRecorder.java b/src/main/java/net/praqma/jenkins/memorymap/MemoryMapRecorder.java
@@ -45,10 +45,9 @@
 import java.util.logging.Level;
 import java.util.logging.Logger;
 import net.praqma.jenkins.memorymap.graph.MemoryMapGraphConfiguration;
-import net.praqma.jenkins.memorymap.parser.AbstractMemoryMapParser;
-import net.praqma.jenkins.memorymap.parser.MemoryMapConfigFileParserDelegate;
-import net.praqma.jenkins.memorymap.parser.MemoryMapMapParserDelegate;
-import net.praqma.jenkins.memorymap.parser.MemoryMapParserDescriptor;
+import net.praqma.jenkins.memorymap.parser.*;
+import net.praqma.jenkins.memorymap.parser.TexasInstrumentsMemoryMapParser;
+import net.praqma.jenkins.memorymap.parser.ti.*;
 import net.praqma.jenkins.memorymap.result.MemoryMapConfigMemory;
 import net.praqma.jenkins.memorymap.util.MemoryMapError;
 import net.sf.json.JSONObject;
@@ -120,6 +119,26 @@ public Object readResolve()
             setChosenParsers(parsers);
         }
 
+        ArrayList<AbstractMemoryMapParser> deprecatedParsers = new ArrayList<>();
+        ArrayList<AbstractMemoryMapParser> newParsers = new ArrayList<>();
+        for(AbstractMemoryMapParser oldParser  : chosenParsers){
+            if(oldParser.getClass().equals(net.praqma.jenkins.memorymap.parser.TexasInstrumentsMemoryMapParser.class)){
+                logger.log(Level.FINE, "Entering Texas Instruments deprecation block, swapping old TI parser with the new one.");
+                net.praqma.jenkins.memorymap.parser.ti.TexasInstrumentsMemoryMapParser newParser = new net.praqma.jenkins.memorymap.parser.ti.TexasInstrumentsMemoryMapParser();
+                newParser.setBytesOnGraph(oldParser.getBytesOnGraph());
+                newParser.setConfigurationFile(oldParser.getConfigurationFile());
+                newParser.setMapFile(oldParser.getMapFile());
+                newParser.setWordSize(oldParser.getWordSize());
+                newParser.setParserTitle(oldParser.getParserTitle());
+                newParser.setParserUniqueName(oldParser.getParserUniqueName());
+                newParser.setGraphConfiguration(oldParser.getGraphConfiguration());
+                deprecatedParsers.add(oldParser);
+                newParsers.add(newParser);
+            }
+        }
+        chosenParsers.removeAll(deprecatedParsers);
+        chosenParsers.addAll(newParsers);
+
         return this;
     }
 

diff --git a/src/main/java/net/praqma/jenkins/memorymap/parser/TexasInstrumentsMemoryMapParser.java b/src/main/java/net/praqma/jenkins/memorymap/parser/TexasInstrumentsMemoryMapParser.java
@@ -43,9 +43,10 @@
 import org.kohsuke.stapler.StaplerRequest;
 
 /**
- *
+ * @deprecated Moved to another package. The MemoryMapRecorder will replace all instances of this with the new one.
  * @author Praqma
  */
+@Deprecated
 public class TexasInstrumentsMemoryMapParser extends AbstractMemoryMapParser {
 
     /*
@@ -138,7 +139,7 @@ public static final class DescriptorImpl extends MemoryMapParserDescriptor<Texas
 
         @Override
         public String getDisplayName() {
-            return "Texas Instruments";
+            return "Texas Instruments (Deprecated)";
         }
 
         @Override

diff --git a/src/main/java/net/praqma/jenkins/memorymap/parser/ti/TexasInstrumentsMemoryMapParser.java b/src/main/java/net/praqma/jenkins/memorymap/parser/ti/TexasInstrumentsMemoryMapParser.java
@@ -0,0 +1,152 @@
+/*
+ * The MIT License
+ *
+ * Copyright 2012 Praqma.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package net.praqma.jenkins.memorymap.parser.ti; //Remains in the parser package for backwards compatibility
+
+import hudson.Extension;
+import net.praqma.jenkins.memorymap.graph.MemoryMapGraphConfiguration;
+import net.praqma.jenkins.memorymap.parser.AbstractMemoryMapParser;
+import net.praqma.jenkins.memorymap.parser.MemoryMapConfigFileParserDelegate;
+import net.praqma.jenkins.memorymap.parser.MemoryMapMapParserDelegate;
+import net.praqma.jenkins.memorymap.parser.MemoryMapParserDescriptor;
+import net.praqma.jenkins.memorymap.result.MemoryMapConfigMemory;
+import net.praqma.jenkins.memorymap.result.MemoryMapConfigMemoryItem;
+import net.praqma.jenkins.memorymap.util.MemoryMapMemorySelectionError;
+import net.sf.json.JSONObject;
+import org.kohsuke.stapler.DataBoundConstructor;
+import org.kohsuke.stapler.StaplerRequest;
+
+import java.io.File;
+import java.io.IOException;
+import java.util.List;
+import java.util.logging.Level;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+/**
+ *
+ * @author Praqma
+ */
+public class TexasInstrumentsMemoryMapParser extends AbstractMemoryMapParser {
+
+    /*
+     * Generic design
+     */
+    private static final Pattern MEMORY_OVERALL_SECTION = Pattern.compile("^\\.text\\s+\\S+\\s+\\S+\\s+(\\S+)", Pattern.MULTILINE);
+    /*
+     * Flash
+     */
+    private static final Pattern TEXT_DOT = Pattern.compile("^\\.text\\s+\\S+\\s+\\S+\\s+(\\S+)", Pattern.MULTILINE);
+    private static final Pattern CONST_DOT = Pattern.compile("^\\.const\\s+\\S+\\s+\\S+\\s+(\\S+)", Pattern.MULTILINE);
+    private static final Pattern ECONST_DOT = Pattern.compile("^\\.econst\\s+\\S+\\s+\\S+\\s+(\\S+)", Pattern.MULTILINE);
+    private static final Pattern PINIT = Pattern.compile("^\\.pinit\\s+\\S+\\s+\\S+\\s+(\\S+)", Pattern.MULTILINE);
+    private static final Pattern SWITCH = Pattern.compile("^\\.switch\\s+\\S+\\s+\\S+\\s+(\\S+)", Pattern.MULTILINE);
+    /*
+     * Ram
+     */
+    private static final Pattern CINIT_DOT = Pattern.compile("^\\.cinit\\s+\\S+\\s+\\S+\\s+(\\S+)", Pattern.MULTILINE);
+    private static final Pattern STACK_DOT = Pattern.compile("^\\.stack\\s+\\S+\\s+\\S+\\s+(\\S+)", Pattern.MULTILINE);
+    private static final Pattern BSS_DOT = Pattern.compile("^\\.bss\\s+\\S+\\s+\\S+\\s+(\\S+)", Pattern.MULTILINE);
+    private static final Pattern EBSS_DOT = Pattern.compile("^\\.ebss\\s+\\S+\\s+\\S+\\s+(\\S+)", Pattern.MULTILINE);
+    private static final Pattern SYSMEM = Pattern.compile("^\\.sysmem\\s+\\S+\\s+\\S+\\s+(\\S+)", Pattern.MULTILINE);
+    private static final Pattern ESYSMEM = Pattern.compile("^\\.esysmem\\s+\\S+\\s+\\S+\\s+(\\S+)", Pattern.MULTILINE);
+    private static final Pattern CIO = Pattern.compile("^\\.cio\\s+\\S+\\s+\\S+\\s+(\\S+)", Pattern.MULTILINE);
+    private static final Pattern DATA = Pattern.compile("^\\.data\\s+\\S+\\s+\\S+\\s+(\\S+)", Pattern.MULTILINE);
+
+    @DataBoundConstructor
+    public TexasInstrumentsMemoryMapParser(String parserUniqueName, String mapFile, String configurationFile, Integer wordSize, List<MemoryMapGraphConfiguration> graphConfiguration, Boolean bytesOnGraph) {
+        super(parserUniqueName,mapFile, configurationFile, wordSize, bytesOnGraph, graphConfiguration, TEXT_DOT, CONST_DOT, ECONST_DOT, PINIT, SWITCH, CINIT_DOT, STACK_DOT, BSS_DOT, EBSS_DOT, SYSMEM, ESYSMEM, CIO, DATA);
+    }
+
+    public TexasInstrumentsMemoryMapParser() {
+        super();
+    }
+
+    @Override
+    public MemoryMapConfigMemory parseConfigFile(File f) throws IOException {
+        MemoryMapConfigMemory config = new MemoryMapConfigMemory();
+        CharSequence sequence = createCharSequenceFromFile(f);
+        for (MemoryMapGraphConfiguration graph : getGraphConfiguration()) {
+            String[] split = graph.getGraphDataList().split(",");
+            for (String s : split) {
+                String[] multiSections = s.trim().split("\\+");
+                for (String ms : multiSections) {
+                    Matcher m = MemoryMapConfigFileParserDelegate.getPatternForMemoryLayout(ms.replace(" ", "")).matcher(sequence);
+                    MemoryMapConfigMemoryItem item = null;
+                    while (m.find()) {
+                        item = new MemoryMapConfigMemoryItem(m.group(1), m.group(3), m.group(5));
+                        config.add(item);
+                    }
+
+                    if (item == null) {
+                        logger.logp(Level.WARNING, "parseConfigFile", AbstractMemoryMapParser.class.getName(), String.format("parseConfigFile(List<MemoryMapGraphConfiguration> graphConfig, File f) non existing item: %s", s));
+                        throw new MemoryMapMemorySelectionError(String.format("No match found for program memory named %s", s));
+                    }
+                }
+
+            }
+        }
+        return config;
+    }
+
+    @Override
+    public MemoryMapConfigMemory parseMapFile(File f, MemoryMapConfigMemory config) throws IOException {
+        CharSequence sequence = createCharSequenceFromFile(f);
+
+        for(MemoryMapConfigMemoryItem item : config) {            
+            Matcher matcher = MemoryMapMapParserDelegate.getPatternForMemorySection(item.getName()).matcher(sequence);
+            boolean found = false;
+            while(matcher.find()) {
+                item.setUsed(matcher.group(8));
+                item.setUnused(matcher.group(10));
+                found = true;
+            }
+            if(!found) {
+                logger.logp(Level.WARNING, "parseMapFile", AbstractMemoryMapParser.class.getName(), String.format("parseMapFile(File f, MemoryMapConfigMemory configuration) non existing item: %s",item));                
+                throw new MemoryMapMemorySelectionError(String.format("Linker command element %s not found in .map file", item));
+            }
+        }
+        return config;
+    }
+
+    @Override
+    public int getDefaultWordSize() {
+        return 16;
+    }
+
+    @Extension
+    public static final class DescriptorImpl extends MemoryMapParserDescriptor<TexasInstrumentsMemoryMapParser> {
+
+        @Override
+        public String getDisplayName() {
+            return "Texas Instruments";
+        }
+
+        @Override
+        public AbstractMemoryMapParser newInstance(StaplerRequest req, JSONObject formData, AbstractMemoryMapParser instance) throws FormException {
+            TexasInstrumentsMemoryMapParser parser = (TexasInstrumentsMemoryMapParser) instance;
+            save();
+            return parser;
+        }
+    }
+}