raptor/lib/raptor/jsdoc/Environment.js

RaptorJS provides an AMD module loader that works in Node, Rhino and the web browser. It also includes various sub-modules to support building optimized web applications.

define(
    "raptor/jsdoc/Environment",
    ['raptor', 'raptor/objects'],
    function(raptor, objects, require, exports, module) {
        "use strict";
        
        var Type = require('raptor/jsdoc/Type'),
            Tag = require('raptor/jsdoc/Tag'),
            File = require('raptor/files/File'),
            SymbolSet = require('raptor/jsdoc/SymbolSet');
        
        var Environment = function(symbols) {
            this.symbols = symbols || new SymbolSet();
            this.handlers = require('raptor/listeners').createObservable();
            this.global = new Type("object", "global");
            this.global.setLabel("Global");
            
            this.symbols.addSymbol("global", this.global);
            this.tagTypes = {};
            this.files = {};


            this.registerTagType("param", require('raptor/jsdoc/ParamTag'));
            this.registerTagType("return", require('raptor/jsdoc/ReturnTag'));
            this.registerTagType("returns", require('raptor/jsdoc/ReturnTag'));
            this.registerTagType("borrows", require('raptor/jsdoc/BorrowTag'));
            this.registerTagType("borrow", require('raptor/jsdoc/BorrowTag'));
        };
        
        Environment.prototype = {
            addFile: function(file, sourceDir) {
                sourceDir = sourceDir.isDirectory() ? sourceDir : sourceDir.getParentFile();
                
                this.files[file.getAbsolutePath()] = {
                    file: file,
                    path: file.getAbsolutePath(),
                    sourceDir: sourceDir,
                    relativePath: file.getAbsolutePath().substring(sourceDir.getAbsolutePath().length),
                    relativeDir: file.getParent().substring(sourceDir.getAbsolutePath().length)
                };
            },

            getSourceDirForFile: function(file) {
                var path;

                if (file instanceof File) {
                    path = file.getAbsolutePath();
                }
                else if (typeof file === 'string') {
                    path = file;
                }

                var entry = this.files[path];
                return entry ? entry.sourceDir : null;
            },

            getGlobal: function() {
                return this.global;
            },
            
            addHandlers: function(handlers, thisObj) {
                this.handlers.subscribe(handlers, thisObj);
            },
            
            registerTagType: function(tagName, TagClass) {
                this.tagTypes[tagName] = TagClass;
            },
            
            parseTag: function(tagName, value) {

                var TagClass = this.tagTypes[tagName],
                    tag = null;

                if (TagClass) {
                    tag = new TagClass(tagName, value);
                }
                
                return tag || new Tag(tagName, value);
            },
            
            publish: function(name, args) {
                this.handlers.publish(name, args);
            },
            
            getSymbols: function() {
                return this.symbols;
            },
            
            setSymbols: function(symbols) {
                this.symbosl = symbols;
            },

            forEachSourceFile: function(callback, thisObj) {
                objects.forEachEntry(this.files, function(path, fileEntry) {
                    callback.call(thisObj, fileEntry);
                });
            }
        };
        
        return Environment;
        
        
    });