aboutsummaryrefslogtreecommitdiff
path: root/engine/src/core-plugins/com/jme3/shader/plugins/GLSLLoader.java
blob: f9073b7232af20202da7963083f5adcd83e9c8a5 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
/*
 * 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 com.jme3.shader.plugins;

import com.jme3.asset.AssetInfo;
import com.jme3.asset.AssetKey;
import com.jme3.asset.AssetLoader;
import com.jme3.asset.AssetManager;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.util.*;

/**
 * GLSL File parser that supports #import pre-processor statement
 */
public class GLSLLoader implements AssetLoader {

    private AssetManager owner;
    private Map<String, DependencyNode> dependCache = new HashMap<String, DependencyNode>();

    private class DependencyNode {

        private String shaderSource;
        private String shaderName;

        private final Set<DependencyNode> dependsOn = new HashSet<DependencyNode>();
        private final Set<DependencyNode> dependOnMe = new HashSet<DependencyNode>();

        public DependencyNode(String shaderName){
            this.shaderName = shaderName;
        }

        public void setSource(String source){
            this.shaderSource = source;
        }

        public void addDependency(DependencyNode node){
            if (this.dependsOn.contains(node))
                return; // already contains dependency

//            System.out.println(shaderName + " depend on "+node.shaderName);
            this.dependsOn.add(node);
            node.dependOnMe.add(this);
        }

    }

    private class GlslDependKey extends AssetKey<InputStream> {
        public GlslDependKey(String name){
            super(name);
        }
        @Override
        public boolean shouldCache(){
            return false;
        }
    }

    private DependencyNode loadNode(InputStream in, String nodeName) throws IOException{
        DependencyNode node = new DependencyNode(nodeName);
        if (in == null)
            throw new IOException("Dependency "+nodeName+" cannot be found.");

        StringBuilder sb = new StringBuilder();
        BufferedReader r = new BufferedReader(new InputStreamReader(in));
        while (r.ready()){
            String ln = r.readLine();
            if (ln.startsWith("#import ")){
                ln = ln.substring(8).trim();
                if (ln.startsWith("\"") && ln.endsWith("\"") && ln.length() > 3){
                    // import user code
                    // remove quotes to get filename
                    ln = ln.substring(1, ln.length()-1);
                    if (ln.equals(nodeName))
                        throw new IOException("Node depends on itself.");

                    // check cache first
                    DependencyNode dependNode = dependCache.get(ln);
                    if (dependNode == null){
                        GlslDependKey key = new GlslDependKey(ln);
                        // make sure not to register an input stream with
                        // the cache..
                        InputStream stream = (InputStream) owner.loadAsset(key);
                        dependNode = loadNode(stream, ln);
                    }
                    node.addDependency(dependNode);
                }
//            }else if (ln.startsWith("uniform") || ln.startsWith("varying") || ln.startsWith("attribute")){
//                // these variables are included as dependencies as well
//                DependencyNode dependNode = dependCache.get(ln);
//                if (dependNode == null){
//                    // the source and name are the same for variable dependencies
//                    dependNode = new DependencyNode(ln);
//                    dependNode.setSource(ln);
//                    dependCache.put(ln, dependNode);
//                }
//                node.addDependency(dependNode);
            }else{
                sb.append(ln).append('\n');
            }
        }
        r.close();

        node.setSource(sb.toString());
        dependCache.put(nodeName, node);
        return node;
    }

    private DependencyNode nextIndependentNode(List<DependencyNode> checkedNodes){
        Collection<DependencyNode> allNodes = dependCache.values();
        if (allNodes == null || allNodes.isEmpty())
            return null;
        
        for (DependencyNode node : allNodes){
            if (node.dependsOn.isEmpty()){
                return node;
            }
        }

        // circular dependency found..
        for (DependencyNode node : allNodes){
            System.out.println(node.shaderName);
        }
        throw new RuntimeException("Circular dependency.");
    }

    private String resolveDependencies(DependencyNode root){
        StringBuilder sb = new StringBuilder();

        List<DependencyNode> checkedNodes = new ArrayList<DependencyNode>();
        checkedNodes.add(root);
        while (true){
            DependencyNode indepnNode = nextIndependentNode(checkedNodes);
            if (indepnNode == null)
                break;

            sb.append(indepnNode.shaderSource).append('\n');
            dependCache.remove(indepnNode.shaderName);
            
            // take out this dependency
            for (Iterator<DependencyNode> iter = indepnNode.dependOnMe.iterator();
                 iter.hasNext();){
                DependencyNode dependNode = iter.next();
                iter.remove();
                dependNode.dependsOn.remove(indepnNode);
            }
        }

//        System.out.println(sb.toString());
//        System.out.println("--------------------------------------------------");
        
        return sb.toString();
    }

    /**
     *
     * @param owner
     * @param in
     * @param extension
     * @param key
     * @return
     * @throws java.io.IOException
     */
    public Object load(AssetInfo info) throws IOException {
        // The input stream provided is for the vertex shader, 
        // to retrieve the fragment shader, use the content manager
        this.owner = info.getManager();
        if (info.getKey().getExtension().equals("glsllib")){
            // NOTE: Loopback, GLSLLIB is loaded by this loader
            // and needs data as InputStream
            return info.openStream();
        }else{
            // GLSLLoader wants result as String for
            // fragment shader
            DependencyNode rootNode = loadNode(info.openStream(), "[main]");
            String code = resolveDependencies(rootNode);
            dependCache.clear();
            return code;
        }
    }

}