Shaders : The line number is now printed for each line of shader code in the standard error output when a shader fail to compile.

git-svn-id: https://jmonkeyengine.googlecode.com/svn/trunk@9294 75d07b2b-3a1a-0410-a2c5-0572b91ccdca

engine/src/android/com/jme3/renderer/android/OGLESShaderRenderer.java

@@ -63,6 +63,7 @@ import java.util.EnumSet;
 import java.util.List;
 import java.util.logging.Level;
 import java.util.logging.Logger;
+import jme3tools.shader.ShaderDebug;
 
 public class OGLESShaderRenderer implements Renderer {
 
@@ -1049,8 +1050,8 @@ public class OGLESShaderRenderer implements Renderer {
                 logger.log(Level.FINE, "compile success: " + source.getName());
             }
         } else {
-           logger.log(Level.WARNING, "Bad compile of:\n{0}{1}",
+           logger.log(Level.WARNING, "Bad compile of:\n{0}",
-                    new Object[]{source.getDefines(), source.getSource()});
+                    new Object[]{ShaderDebug.formatShaderSource(source.getDefines(), source.getSource())});
             if (infoLog != null) {
                 throw new RendererException("compile error in:" + source + " error:" + infoLog);
             } else {

engine/src/lwjgl/com/jme3/renderer/lwjgl/LwjglRenderer.java

@@ -65,6 +65,7 @@ import java.util.List;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 import jme3tools.converters.MipMapGenerator;
+import jme3tools.shader.ShaderDebug;
 import static org.lwjgl.opengl.ARBTextureMultisample.*;
 import static org.lwjgl.opengl.EXTFramebufferBlit.*;
 import static org.lwjgl.opengl.EXTFramebufferMultisample.*;
@@ -996,8 +997,8 @@ public class LwjglRenderer implements Renderer {
                 logger.log(Level.FINE, "{0} compile success", source.getName());
             }
         } else {            
-            logger.log(Level.WARNING, "Bad compile of:\n{0}{1}",
+            logger.log(Level.WARNING, "Bad compile of:\n{0}",
-                    new Object[]{source.getDefines(), source.getSource()});
+                    new Object[]{ShaderDebug.formatShaderSource(source.getDefines(), source.getSource())});
             if (infoLog != null) {
                 throw new RendererException("compile error in:" + source + " error:" + infoLog);
             } else {
@@ -1234,14 +1235,17 @@ public class LwjglRenderer implements Renderer {
 
     private String getTargetBufferName(int buffer) {
         switch (buffer) {
-            case GL_NONE: return "NONE";
+            case GL_NONE:
-            case GL_FRONT: return "GL_FRONT";
+                return "NONE";
-            case GL_BACK: return "GL_BACK";
+            case GL_FRONT:
+                return "GL_FRONT";
+            case GL_BACK:
+                return "GL_BACK";
             default:
                 if (buffer >= GL_COLOR_ATTACHMENT0_EXT
                         && buffer <= GL_COLOR_ATTACHMENT15_EXT) {
-                    return "GL_COLOR_ATTACHMENT" + 
+                    return "GL_COLOR_ATTACHMENT"
-                                (buffer - GL_COLOR_ATTACHMENT0_EXT);
+                            + (buffer - GL_COLOR_ATTACHMENT0_EXT);
                 } else {
                     return "UNKNOWN? " + buffer;
                 }
@@ -1531,8 +1535,8 @@ public class LwjglRenderer implements Renderer {
             lastFb = null;
         } else {
             if (fb.getNumColorBuffers() == 0 && fb.getDepthBuffer() == null) {
-                throw new IllegalArgumentException("The framebuffer: " + fb + 
+                throw new IllegalArgumentException("The framebuffer: " + fb
-                                                   "\nDoesn't have any color/depth buffers");
+                        + "\nDoesn't have any color/depth buffers");
             }
 
             if (fb.isUpdateNeeded()) {

engine/src/tools/jme3tools/shader/ShaderDebug.java

@@ -0,0 +1,63 @@
+/*
+ * Copyright (c) 2009-2010 jMonkeyEngine
+ * 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 'jMonkeyEngine' 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.
+ */
+package jme3tools.shader;
+
+/**
+ * Static tool box class for convenient methods to help debug shaders
+ * @author Nehon
+ */
+public class ShaderDebug {
+
+    /**
+     * Append the line numbers to the source code of a shader to output it
+     * @param defines the defines
+     * @param source the source
+     * @return the formated source code
+     */
+    public static String formatShaderSource(String defines, String source) {
+        String[] lines = defines.split("\n");
+        String[] lines2 = source.split("\n");
+        int nblines = 0;
+        StringBuilder out = new StringBuilder();
+        if (!defines.equals("")) {
+            for (String string : lines) {
+                nblines++;
+                out.append(nblines).append("\t").append(string).append("\n");
+            }
+        }
+        for (String string : lines2) {
+            nblines++;
+            out.append(nblines).append("\t").append(string).append("\n");
+        }
+        return out.toString();
+    }
+}