127 lines
3.2 KiB
JavaScript
Executable File
127 lines
3.2 KiB
JavaScript
Executable File
/*\
|
|
title: js/Tiddler.js
|
|
|
|
Tiddlers are an immutable dictionary of name:value pairs called fields. Values can be a string, an array
|
|
of strings, or a date. The only field that is required is the `title` field, but useful tiddlers also
|
|
have a `text` field, and some of the standard fields `modified`, `modifier`, `created`, `creator`,
|
|
`tags` and `type`.
|
|
|
|
Hardcoded in the system is the knowledge that the 'tags' field is a string array, and that the 'modified'
|
|
and 'created' fields are dates. All other fields are strings.
|
|
|
|
The Tiddler object exposes the following API
|
|
|
|
new Tiddler(src) - create a Tiddler given a hashmap of field values or a tiddler to clone
|
|
new Tiddler(src1,src2) - create a Tiddler with the union of the fields from the
|
|
sources, with the rightmost taking priority
|
|
Tiddler.fields - hashmap of tiddler fields, OK for read-only access
|
|
|
|
The hashmap(s) can specify the "modified" and "created" fields as strings in YYYYMMDDHHMMSSMMM
|
|
format or as JavaScript date objects. The "tags" field can be given as a JavaScript array of strings or
|
|
as a TiddlyWiki quoted string (eg, "one [[two three]]").
|
|
|
|
\*/
|
|
(function(){
|
|
|
|
/*jslint node: true */
|
|
"use strict";
|
|
|
|
var utils = require("./Utils.js"),
|
|
ArgParser = require("./ArgParser.js").ArgParser,
|
|
WikiTextParser = require("./WikiTextParser.js").WikiTextParser;
|
|
|
|
var Tiddler = function(/* tiddler,fields */) {
|
|
this.fields = {};
|
|
for(var c=0; c<arguments.length; c++) {
|
|
var arg = arguments[c],
|
|
src = null;
|
|
if(arg instanceof Tiddler) {
|
|
src = arg.fields;
|
|
} else {
|
|
src = arg;
|
|
}
|
|
for(var t in src) {
|
|
var f = this.parseTiddlerField(t,src[t]);
|
|
if(f !== null) {
|
|
this.fields[t] = f;
|
|
}
|
|
}
|
|
}
|
|
};
|
|
|
|
Tiddler.standardFields = {
|
|
title: { type: "string"},
|
|
modifier: { type: "string"},
|
|
modified: { type: "date"},
|
|
creator: { type: "string"},
|
|
created: { type: "date"},
|
|
tags: { type: "tags"},
|
|
type: { type: "string"},
|
|
text: { type: "string"}
|
|
}
|
|
|
|
Tiddler.isStandardField = function(name) {
|
|
return name in Tiddler.standardFields;
|
|
};
|
|
|
|
Tiddler.prototype.hasTag = function(tag) {
|
|
if(this.tags) {
|
|
for(var t=0; t<this.tags.length; t++) {
|
|
if(this.tags[t] === tag) {
|
|
return true;
|
|
}
|
|
}
|
|
}
|
|
return false;
|
|
};
|
|
|
|
Tiddler.prototype.parseTiddlerField = function(name,value) {
|
|
var type = Tiddler.specialTiddlerFields[name];
|
|
if(type) {
|
|
return Tiddler.specialTiddlerFieldParsers[type](value);
|
|
} else if (typeof value === "string") {
|
|
return value;
|
|
} else {
|
|
return null;
|
|
}
|
|
};
|
|
|
|
// These are the non-string fields
|
|
Tiddler.specialTiddlerFields = {
|
|
"created": "date",
|
|
"modified": "date",
|
|
"tags": "array"
|
|
};
|
|
|
|
Tiddler.specialTiddlerFieldParsers = {
|
|
date: function(value) {
|
|
if(typeof value === "string") {
|
|
return utils.convertFromYYYYMMDDHHMMSSMMM(value);
|
|
} else if (value instanceof Date) {
|
|
return value;
|
|
} else {
|
|
return null;
|
|
}
|
|
},
|
|
array: function(value) {
|
|
if(typeof value === "string") {
|
|
var parser = new ArgParser(value,{noNames: true});
|
|
return parser.getValuesByName("","");
|
|
} else if (value instanceof Array) {
|
|
var result = [];
|
|
for(var t=0; t<value.length; t++) {
|
|
if(typeof value[t] === "string") {
|
|
result.push(value[t]);
|
|
}
|
|
}
|
|
return result;
|
|
} else {
|
|
return null;
|
|
}
|
|
}
|
|
};
|
|
|
|
exports.Tiddler = Tiddler;
|
|
|
|
})();
|