ares-ide/deimos/source/ProjectKindsModel.js

A browser-based code editor and UI designer for Enyo 2 projects

/* global ProjectKindsModel, ares */
// Store all information coming from all .design files of a project.
// This is reset whenever a project change
// This is used by Palette and inspector
enyo.singleton({
	name: "ProjectKindsModel",
	kind: "enyo.Component",
	debug: false,
	info: {},
	kindOptions: {},
	serializerOptions: {},
	defaults: {
		properties: {
			owner: {filterLevel: "hidden"},
			container: {filterLevel: "hidden"},
			parent: {filterLevel: "hidden"},
			prepend: {filterLevel: "hidden"},
			events: {filterLevel: "hidden"},
			id: {filterLevel: "hidden"},
			isContainer: {filterLevel: "hidden"},
			controlParentName: {filterLevel: "hidden"},
			layoutKind: {filterLevel: "hidden"},
			canGenerate: {filterLevel: "dangerous", inputKind: "Inspector.Config.Boolean"},
			content: {filterLevel: "useful", inputKind: "Inspector.Config.Text"},
			name: {filterLevel: "useful", inputKind: "Inspector.Config.Text"}
		},
		events: {
			ontap: {filterLevel: "useful"}
		}
	},
	defaultKindOptions: {
		"enyo.Repeater": {"isRepeater": true}
	},
	defaultSerializerOptions: {
	},
	F_HIDDEN: -1,
	F_DANGEROUS: 1,
	F_NORMAL: 2,
	F_USEFUL: 3,

	levelMapping: null,			// Instanciated at create() time
	create: function() {
		ares.setupTraceLogger(this);
		this.inherited(arguments);
		//
		this.levelMapping = {
			"hidden": this.F_HIDDEN,
			"dangerous": this.F_DANGEROUS,
			"normal": this.F_NORMAL,
			"useful": this.F_USEFUL
		};
	},
	/**
	 * Reset the ProjectKindsModel Information to default
	 * @public
	 */
	resetInformation: function() {
		this.trace("resetInformation!");
		this.info = {};
		this.addInformation("properties", "__default", this.defaults.properties);
		this.addInformation("events", "__default", this.defaults.events);

		this.kindOptions = enyo.clone(this.defaultKindOptions);
		this.serializerOptions = enyo.clone(this.defaultSerializerOptions);
	},
	/**
	 * Build all the information needed by the inspector
	 * @public
	 */
	buildInformation: function(projectIndexer) {
		this.trace("buildInformation: Indexer: ", projectIndexer);
		this.resetInformation();
		enyo.forEach(projectIndexer.design.inspector, function(item) {
			if (item.type === "kind") {
				this.trace("Processing: ", item.name, item);
				this.addInformation("properties", item.name, item.properties);
				this.addInformation("events", item.name, item.events);
			} else {
				enyo.error("Unknown data type='" + item.type + "' -- Ignored");
			}
		}, this);

		this.addKindOptions(projectIndexer.design.palette);
		this.addSerializerOptions(projectIndexer.design.serializer);
	},
	// @protected
	addKindOptions: function(palette) {
		enyo.forEach(palette, function(category) {
			enyo.forEach(category.items, function(item) {
				if (item.options) {
					this.kindOptions[item.config.kind || ""] = item.options;
				}
			}, this);
		}, this);
	},
	// @public
	getKindOptions: function(name) {
		return this.kindOptions[name] || this.kindOptions["enyo." + name];
	},
	// @protected
	addSerializerOptions: function(data) {
		// Prepare serializer options for the designerFrame
		enyo.forEach(data, function(item) {
			var kindName = item.name;
			var info = this.serializerOptions[kindName];
			if ( ! info) {
				this.serializerOptions[kindName] = info = {};
			}
			info.exclude = item.exclude;
		}, this);
	},
	// @protected
	addInformation: function(inType, inName, inInfo) {
		if (inInfo) {
			this.trace("addInformation: Adding ", inType, " information for ", inName);

			var fn = function(inType, inName, inSubName, inData) {
				if (inData.filterLevel) {
					inData.level = ProjectKindsModel.levelMapping[inData.filterLevel];
					if ( ! inData.level) {
						inData.level = ProjectKindsModel.F_NORMAL;
						enyo.error("Invalid filter level for " + inType + " " + inName + "." + inSubName);
					}
				} else {
					inData.level = ProjectKindsModel.F_NORMAL;
				}
				this.trace("addInformation: Setting level ", inData.level, " for ", inType, " ", inName, ".", inSubName);
			};
			var addFilterLevel = enyo.bind(this, fn, inType, inName);

			if ( ! this.info[inName]) {
				this.info[inName] = {};
			}
			this.info[inName][inType] = inInfo;

			var keys = Object.keys(inInfo);
			for (var n = 0; n < keys.length; n++) {
				addFilterLevel(keys[n], inInfo[keys[n]]);
			}
		}
	},
	getInfo: function(inKind, inType, inName) {
		// enyo kinds don't always have the enyo prefix
		var inf = this.info[inKind] || this.info["enyo." + inKind] ;

		var hasInfo = inf && inf[inType] && inf[inType].hasOwnProperty(inName);
		return hasInfo ? inf[inType][inName] : undefined ;
	},
	getFilterLevel: function(inKind, inType, inName) {
		var info = this.getInfo(inKind, inType, inName);

		if (info && info.level) {
			return info.level;
		} else {
			info = this.getInfo("__default", inType, inName) ;
			return (info && info.level) || ProjectKindsModel.F_NORMAL;
		}
	},
	getFlattenedContainerInfo: function() {		
		// TODO: item containerData is set to null, revisit this,
		// function called by the Designer.sendDesignerFrameContainerData()
		return null;
	}
});