Log.java

Go to the documentation of this file.

/*******************************************************************************
 * Copyright 2010 Neuron Robotics, LLC
 * 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.
 ******************************************************************************/
package com.neuronrobotics.sdk.common;
 
import java.io.PrintStream;
import java.io.PrintWriter;
import java.io.StringWriter;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
import java.util.Date;
 
import com.neuronrobotics.sdk.config.SDKBuildInfo;
// TODO: Auto-generated Javadoc
public class Log {
    
    
    
    public static final int LOG =-1;
    
    public static final int INFO = 0;
    
    public static final int DEBUG = 1;
    
    public static final int WARNING = 2;
    
    public static final int ERROR = 3;
    
    private static Log instance;
    
    private Message m;
    //private ArrayList<Message> messages = new ArrayList<Message>();
    
    private DateFormat dateFormat = new SimpleDateFormat("yyyy/MM/dd HH:mm:ss:SS");
    
    private int minprintlevel = WARNING;
    
    private boolean systemprint = false;
    
    private boolean debugprint = false;
    
    private static PrintStream outStream = System.out;
    
    private static PrintStream errStream = System.err;
    
    private boolean useColoredPrints=false;
    
 
    private Log() {
        // private for singleton pattern
        add(SDKBuildInfo.getSDKVersionString(), INFO);
    }
 
    public static void error(String message) {
        instance().add(message, ERROR);
    }
    
    public static void warning(String message) {
        instance().add(message, WARNING);
    }
    
    public static void info(String message) {
        instance().add(message, INFO);
    }
    
    public static void log(String message) {
        instance().add(message, LOG);   
    }
    
    public static void debug(String message) {
        instance().add(message, DEBUG);
    }
    
    public static void add(String message) {
        instance().add(message, LOG);   
    }
    
    private void add(String message, int importance) {
        
        if( importance < minprintlevel) {
            return;
        }
        if(m==null)
            m = new Message(message, importance);
        else{
            m.init(message, importance);
        }
        //messages.add(m);
        
        if(isPrinting() && importance >= minprintlevel && systemprint) {
            errStream.println(m);
            if(errStream != System.err)
                 System.err.println(m);
        }
        
        if(debugprint&& systemprint) {
            outStream.println("# " + message);
            if(outStream != System.out)
                 System.out.println(m);
        }
        
        
    }
    
    public static void enableSystemPrint(boolean systemprint) {
        Log.instance().systemprint = systemprint;
    }
    
    public static void enableDebugPrint() {
        Log.enableSystemPrint(true);
        Log.setMinimumPrintLevel(DEBUG);
    }
    
    public static void enableDebugPrint(boolean flag) {
        Log.enableSystemPrint(flag);
        Log.setMinimumPrintLevel(DEBUG);
    }
    
    public static void enableInfoPrint() {
        Log.enableSystemPrint(true);
        Log.setMinimumPrintLevel(INFO);
    }
    
    public static void enableWarningPrint() {
        Log.enableSystemPrint(true);
        Log.setMinimumPrintLevel(WARNING);
    }
    
    public static void enableErrorPrint() {
        Log.enableSystemPrint(true);
        Log.setMinimumPrintLevel(ERROR);
    }
    
    
    public static void setMinimumPrintLevel(int level) {
        Log.instance().minprintlevel = level;
    }
    
    public static int getMinimumPrintLevel() {
        return Log.instance().minprintlevel;
    }
    
    public static Log instance() {
        if(instance == null) {
            instance = new Log();
        }
        return instance;
    }
    
    public String getImportance(int importance) {
        switch(importance) {
        case INFO:
            return "Info";
        case WARNING:
            return "Warning";
        case ERROR:
            return "Error";
        case DEBUG:
            return "Debug";
        case LOG:
        default:
            return "Log";
        }
    }
    public String getImportanceColor(int importance) {
        if(isUseColoredPrints()){
            switch(importance) {
            case INFO:
                return "\033[92m";// green
            case WARNING:
                return "\033[93m";// orange
            case ERROR:
                return "\033[31m";// red
            case DEBUG:
                return "\033[94m";// blue
            case LOG:
            default:
                return "\033[92m";// green
            }
        }
        return "";
    }
    
    public static PrintStream getErrStream() {
        return errStream;
    }
    
    public static void setErrStream(PrintStream newerrStream) {
        errStream = newerrStream;
    }
    
    public static PrintStream getOutStream() {
        return outStream;
    }
    
    public static void setOutStream(PrintStream newoutStream) {
        outStream = newoutStream;
    }
    
    private class Message {
        
        private String message;
        
        private int importance;
        
        private Date datetime;
        
        private String callingClass;
 
        public Message(String message, int importance) {
            init(message, importance);
        }
        
        public void init(String message, int importance){
            this.message = message;
            this.importance = importance;
            datetime = new Date();
              try
              {
                 throw new Exception("Who called me?");
              }
              catch( Exception e )
              {
                 callingClass= e.getStackTrace()[3].getClassName()+":"+e.getStackTrace()[3].getMethodName();
              }
        }
        
        /* (non-Javadoc)
         * @see java.lang.Object#toString()
         */
        public String toString() {
            //return "\t\t\t\t[" + dateFormat.format(datetime) + "] " + " " + getImportance(importance) +" "+callingClass+ " :\n"+ message;
            return getImportanceColor(importance)+"\t\t\t\t[" + dateFormat.format(datetime) + "] " + " " + getImportance(importance) +" "+callingClass+ " :\n"+ message+getColorNormalizationCode();
        }
    }
    
    private String getColorNormalizationCode(){
        if(isUseColoredPrints())
            return "\033[39m";
        return "";
    }
    
    public static  boolean isUseColoredPrints() {
        return instance().useColoredPrints;
    }
    
    public static void setUseColoredPrints(boolean useColoredPrints) {
        instance().useColoredPrints = useColoredPrints;
    }
 
    public static boolean isPrinting() {
        // TODO Auto-generated method stub
        return instance().systemprint;
    }
 
    public static void error(Throwable ex) {
        StringWriter sw = new StringWriter();
        PrintWriter pw = new PrintWriter(sw);
        ex.printStackTrace(pw);
        String sStackTrace = sw.toString(); // stack trace as a string
        Log.error(sStackTrace);
    }
    
}