JSDuck: Generated code documentation!
See CODING.md for how to run it.
Mistakes fixed:
* Warning: Unknown type function
-> Function
* Warning: Unknown type DOMElement
-> HTMLElement
* Warning: Unknown type DOM Node
-> HTMLElement
* Warning: Unknown type Integer
-> Mixed
* Warning: Unknown type Command
-> ve.Command
* Warning: Unknown type any
-> number
* Warning: Unknown type ve.Transaction
-> ve.dm.Transaction
* Warning: Unknown type ve.dm.AnnotationSet
-> ve.AnnotationSet
* Warning: Unknown type false
-> boolean
* Warning: Unknown type ve.dm.AlienNode
ve.dm doesn't have a generic AlienNode like ve.ce
-> Unknown type ve.dm.AlienInlineNode|ve.dm.AlienBlockNode
* Warning: Unknown type ve.ve.Surface
-> ve.ce.Surface
* ve.example.lookupNode:
-> Last @param should be @return
* ve.dm.Transaction.prototype.pushReplace:
-> @param {Array] should be @param {Array}
* Warning: ve.BranchNode.js:27: {@link ve.Node#hasChildren} links to non-existing member
-> (removed)
* Warning: ve.LeafNode.js:21: {@link ve.Node#hasChildren} links to non-existing member
-> (removed)
Differences fixed:
* Variadic arguments are like @param {Type...} [name]
instead of @param {Type} [name...]
* Convert all file headers from /** to /*! because JSDuck tries
to parse all /** blocks and fails to parse with all sorts of
errors for "Global property", "Unnamed property", and
"Duplicate property".
Find: \/\*\*([^@]+)(@copyright)
Replace: /*!$1$2
* Indented blocks are considered code examples.
A few methods had documentation with numbered lists that were
indented, which have now been updated to not be intended.
* The free-form text descriptions are parsed with Markdown,
which requires lists to be separated from paragraphs by an
empty line.
And we should use `backticks` instead of {braces} for inline
code in text paragraphs.
* Doc blocks for classes and their constructor have to be
in the correct order (@constructor, @param, @return must be
before @class, @abstract, @extends etc.)
* `@extends Class` must not have Class {wrapped}
* @throws must start with a {Type}
* @example means something else. It is used for an inline demo
iframe, not code block. For that simply indent with spaces.
* @member means something else.
Non-function properties are marked with @property, not @member.
* To create a link to a class or member, in most cases the name
is enough to create a link. E.g. Foo, Foo.bar, Foo.bar#quux,
where a hash stands for "instance member", so Foo.bar#quux,
links to Foo.bar.prototype.quux (the is not supported, as
"prototype" is considered an implementation detail, it only
indexes class name and method name).
If the magic linker doesn't work for some case, the
verbose syntax is {@link #target label}.
* @property can't have sub-properties (nested @param and @return
values are supported, only @static @property can't be nested).
We only have one case of this, which can be worked around by
moving those in a new virtual class. The code is unaltered
(only moved down so that it isn't with the scope of the main
@class block). ve.dm.TransactionProcessor.processors.
New:
* @mixins: Classes mixed into the current class.
* @event: Events that can be emitted by a class. These are also
inherited by subclasses. (+ @param, @return and @preventable).
So ve.Node#event-attach is inherited to ve.dm.BreakNode,
just like @method is.
* @singleton: Plain objects such as ve, ve.dm, ve.ce were missing
documentation causing a tree error. Documented those as a
JSDuck singleton, which they but just weren't documented yet.
NB: Members of @singleton don't need @static (if present,
triggers a compiler warning).
* @chainable: Shorthand for "@return this". We were using
"@return {classname}" which is ambiguous (returns the same
instance or another instance?), @chainable is specifically
for "@return this". Creates proper labels in the generated
HTML pages.
Removed:
* @mixin: (not to be confused with @mixins). Not supported by
JSDuck. Every class is standalone anyway. Where needed marked
them @class + @abstract instead.
Change-Id: I6a7c9e8ee8f995731bc205d666167874eb2ebe23
2013-01-04 08:54:17 +00:00
|
|
|
/*!
|
2013-02-20 19:44:44 +00:00
|
|
|
* VisualEditor MediaWiki Initialization Platform class.
|
2012-07-20 23:59:59 +00:00
|
|
|
*
|
2020-01-08 17:13:04 +00:00
|
|
|
* @copyright 2011-2020 VisualEditor Team and others; see AUTHORS.txt
|
2012-07-20 23:59:59 +00:00
|
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
/**
|
2013-01-15 23:38:49 +00:00
|
|
|
* Initialization MediaWiki platform.
|
2012-07-20 23:59:59 +00:00
|
|
|
*
|
|
|
|
|
* @class
|
JSDuck: Generated code documentation!
See CODING.md for how to run it.
Mistakes fixed:
* Warning: Unknown type function
-> Function
* Warning: Unknown type DOMElement
-> HTMLElement
* Warning: Unknown type DOM Node
-> HTMLElement
* Warning: Unknown type Integer
-> Mixed
* Warning: Unknown type Command
-> ve.Command
* Warning: Unknown type any
-> number
* Warning: Unknown type ve.Transaction
-> ve.dm.Transaction
* Warning: Unknown type ve.dm.AnnotationSet
-> ve.AnnotationSet
* Warning: Unknown type false
-> boolean
* Warning: Unknown type ve.dm.AlienNode
ve.dm doesn't have a generic AlienNode like ve.ce
-> Unknown type ve.dm.AlienInlineNode|ve.dm.AlienBlockNode
* Warning: Unknown type ve.ve.Surface
-> ve.ce.Surface
* ve.example.lookupNode:
-> Last @param should be @return
* ve.dm.Transaction.prototype.pushReplace:
-> @param {Array] should be @param {Array}
* Warning: ve.BranchNode.js:27: {@link ve.Node#hasChildren} links to non-existing member
-> (removed)
* Warning: ve.LeafNode.js:21: {@link ve.Node#hasChildren} links to non-existing member
-> (removed)
Differences fixed:
* Variadic arguments are like @param {Type...} [name]
instead of @param {Type} [name...]
* Convert all file headers from /** to /*! because JSDuck tries
to parse all /** blocks and fails to parse with all sorts of
errors for "Global property", "Unnamed property", and
"Duplicate property".
Find: \/\*\*([^@]+)(@copyright)
Replace: /*!$1$2
* Indented blocks are considered code examples.
A few methods had documentation with numbered lists that were
indented, which have now been updated to not be intended.
* The free-form text descriptions are parsed with Markdown,
which requires lists to be separated from paragraphs by an
empty line.
And we should use `backticks` instead of {braces} for inline
code in text paragraphs.
* Doc blocks for classes and their constructor have to be
in the correct order (@constructor, @param, @return must be
before @class, @abstract, @extends etc.)
* `@extends Class` must not have Class {wrapped}
* @throws must start with a {Type}
* @example means something else. It is used for an inline demo
iframe, not code block. For that simply indent with spaces.
* @member means something else.
Non-function properties are marked with @property, not @member.
* To create a link to a class or member, in most cases the name
is enough to create a link. E.g. Foo, Foo.bar, Foo.bar#quux,
where a hash stands for "instance member", so Foo.bar#quux,
links to Foo.bar.prototype.quux (the is not supported, as
"prototype" is considered an implementation detail, it only
indexes class name and method name).
If the magic linker doesn't work for some case, the
verbose syntax is {@link #target label}.
* @property can't have sub-properties (nested @param and @return
values are supported, only @static @property can't be nested).
We only have one case of this, which can be worked around by
moving those in a new virtual class. The code is unaltered
(only moved down so that it isn't with the scope of the main
@class block). ve.dm.TransactionProcessor.processors.
New:
* @mixins: Classes mixed into the current class.
* @event: Events that can be emitted by a class. These are also
inherited by subclasses. (+ @param, @return and @preventable).
So ve.Node#event-attach is inherited to ve.dm.BreakNode,
just like @method is.
* @singleton: Plain objects such as ve, ve.dm, ve.ce were missing
documentation causing a tree error. Documented those as a
JSDuck singleton, which they but just weren't documented yet.
NB: Members of @singleton don't need @static (if present,
triggers a compiler warning).
* @chainable: Shorthand for "@return this". We were using
"@return {classname}" which is ambiguous (returns the same
instance or another instance?), @chainable is specifically
for "@return this". Creates proper labels in the generated
HTML pages.
Removed:
* @mixin: (not to be confused with @mixins). Not supported by
JSDuck. Every class is standalone anyway. Where needed marked
them @class + @abstract instead.
Change-Id: I6a7c9e8ee8f995731bc205d666167874eb2ebe23
2013-01-04 08:54:17 +00:00
|
|
|
* @extends ve.init.Platform
|
2013-02-20 19:44:44 +00:00
|
|
|
*
|
2012-07-20 23:59:59 +00:00
|
|
|
* @constructor
|
|
|
|
|
*/
|
2012-09-06 23:15:55 +00:00
|
|
|
ve.init.mw.Platform = function VeInitMwPlatform() {
|
Object management: Object create/inherit/clone utilities
* For the most common case:
- replace ve.extendClass with ve.inheritClass (chose slightly
different names to detect usage of the old/new one, and I
like 'inherit' better).
- move it up to below the constructor, see doc block for why.
* Cases where more than 2 arguments were passed to
ve.extendClass are handled differently depending on the case.
In case of a longer inheritance tree, the other arguments
could be omitted (like in "ve.ce.FooBar, ve.FooBar,
ve.Bar". ve.ce.FooBar only needs to inherit from ve.FooBar,
because ve.ce.FooBar inherits from ve.Bar).
In the case of where it previously had two mixins with
ve.extendClass(), either one becomes inheritClass and one
a mixin, both to mixinClass().
No visible changes should come from this commit as the
instances still all have the same visible properties in the
end. No more or less than before.
* Misc.:
- Be consistent in calling parent constructors in the
same order as the inheritance.
- Add missing @extends and @param documentation.
- Replace invalid {Integer} type hint with {Number}.
- Consistent doc comments order:
@class, @abstract, @constructor, @extends, @params.
- Fix indentation errors
A fairly common mistake was a superfluous space before the
identifier on the assignment line directly below the
documentation comment.
$ ack "^ [^*]" --js modules/ve
- Typo "Inhertiance" -> "Inheritance".
- Replacing the other confusing comment "Inheritance" (inside
the constructor) with "Parent constructor".
- Add missing @abstract for ve.ui.Tool.
- Corrected ve.FormatDropdownTool to ve.ui.FormatDropdownTool.js
- Add function names to all @constructor functions. Now that we
have inheritance it is important and useful to have these
functions not be anonymous.
Example of debug shot: http://cl.ly/image/1j3c160w3D45
Makes the difference between
< documentNode;
> ve_dm_DocumentNode
...
: ve_dm_BranchNode
...
: ve_dm_Node
...
: ve_dm_Node
...
: Object
...
without names (current situation):
< documentNode;
> Object
...
: Object
...
: Object
...
: Object
...
: Object
...
though before this commit, it really looks like this
(flattened since ve.extendClass really did a mixin):
< documentNode;
> Object
...
...
...
Pattern in Sublime (case-sensitive) to find nameless
constructor functions:
"^ve\..*\.([A-Z])([^\.]+) = function \("
Change-Id: Iab763954fb8cf375900d7a9a92dec1c755d5407e
2012-09-05 06:07:47 +00:00
|
|
|
// Parent constructor
|
2012-07-20 23:59:59 +00:00
|
|
|
ve.init.Platform.call( this );
|
|
|
|
|
|
|
|
|
|
// Properties
|
2014-07-14 21:32:49 +00:00
|
|
|
this.externalLinkUrlProtocolsRegExp = new RegExp(
|
2015-08-14 04:09:24 +00:00
|
|
|
'^(' + mw.config.get( 'wgUrlProtocols' ) + ')',
|
|
|
|
|
'i'
|
2014-07-14 21:32:49 +00:00
|
|
|
);
|
2015-08-12 20:55:31 +00:00
|
|
|
this.unanchoredExternalLinkUrlProtocolsRegExp = new RegExp(
|
2015-08-14 04:09:24 +00:00
|
|
|
'(' + mw.config.get( 'wgUrlProtocols' ) + ')',
|
|
|
|
|
'i'
|
2015-08-12 20:55:31 +00:00
|
|
|
);
|
2012-12-04 06:56:41 +00:00
|
|
|
this.parsedMessages = {};
|
2014-03-11 00:46:26 +00:00
|
|
|
this.linkCache = new ve.init.mw.LinkCache();
|
2014-12-16 01:06:05 +00:00
|
|
|
this.imageInfoCache = new ve.init.mw.ImageInfoCache();
|
2016-09-30 16:07:10 +00:00
|
|
|
this.galleryImageInfoCache = new ve.init.mw.GalleryImageInfoCache();
|
2012-07-20 23:59:59 +00:00
|
|
|
};
|
|
|
|
|
|
Object management: Object create/inherit/clone utilities
* For the most common case:
- replace ve.extendClass with ve.inheritClass (chose slightly
different names to detect usage of the old/new one, and I
like 'inherit' better).
- move it up to below the constructor, see doc block for why.
* Cases where more than 2 arguments were passed to
ve.extendClass are handled differently depending on the case.
In case of a longer inheritance tree, the other arguments
could be omitted (like in "ve.ce.FooBar, ve.FooBar,
ve.Bar". ve.ce.FooBar only needs to inherit from ve.FooBar,
because ve.ce.FooBar inherits from ve.Bar).
In the case of where it previously had two mixins with
ve.extendClass(), either one becomes inheritClass and one
a mixin, both to mixinClass().
No visible changes should come from this commit as the
instances still all have the same visible properties in the
end. No more or less than before.
* Misc.:
- Be consistent in calling parent constructors in the
same order as the inheritance.
- Add missing @extends and @param documentation.
- Replace invalid {Integer} type hint with {Number}.
- Consistent doc comments order:
@class, @abstract, @constructor, @extends, @params.
- Fix indentation errors
A fairly common mistake was a superfluous space before the
identifier on the assignment line directly below the
documentation comment.
$ ack "^ [^*]" --js modules/ve
- Typo "Inhertiance" -> "Inheritance".
- Replacing the other confusing comment "Inheritance" (inside
the constructor) with "Parent constructor".
- Add missing @abstract for ve.ui.Tool.
- Corrected ve.FormatDropdownTool to ve.ui.FormatDropdownTool.js
- Add function names to all @constructor functions. Now that we
have inheritance it is important and useful to have these
functions not be anonymous.
Example of debug shot: http://cl.ly/image/1j3c160w3D45
Makes the difference between
< documentNode;
> ve_dm_DocumentNode
...
: ve_dm_BranchNode
...
: ve_dm_Node
...
: ve_dm_Node
...
: Object
...
without names (current situation):
< documentNode;
> Object
...
: Object
...
: Object
...
: Object
...
: Object
...
though before this commit, it really looks like this
(flattened since ve.extendClass really did a mixin):
< documentNode;
> Object
...
...
...
Pattern in Sublime (case-sensitive) to find nameless
constructor functions:
"^ve\..*\.([A-Z])([^\.]+) = function \("
Change-Id: Iab763954fb8cf375900d7a9a92dec1c755d5407e
2012-09-05 06:07:47 +00:00
|
|
|
/* Inheritance */
|
|
|
|
|
|
2013-10-11 21:44:09 +00:00
|
|
|
OO.inheritClass( ve.init.mw.Platform, ve.init.Platform );
|
Object management: Object create/inherit/clone utilities
* For the most common case:
- replace ve.extendClass with ve.inheritClass (chose slightly
different names to detect usage of the old/new one, and I
like 'inherit' better).
- move it up to below the constructor, see doc block for why.
* Cases where more than 2 arguments were passed to
ve.extendClass are handled differently depending on the case.
In case of a longer inheritance tree, the other arguments
could be omitted (like in "ve.ce.FooBar, ve.FooBar,
ve.Bar". ve.ce.FooBar only needs to inherit from ve.FooBar,
because ve.ce.FooBar inherits from ve.Bar).
In the case of where it previously had two mixins with
ve.extendClass(), either one becomes inheritClass and one
a mixin, both to mixinClass().
No visible changes should come from this commit as the
instances still all have the same visible properties in the
end. No more or less than before.
* Misc.:
- Be consistent in calling parent constructors in the
same order as the inheritance.
- Add missing @extends and @param documentation.
- Replace invalid {Integer} type hint with {Number}.
- Consistent doc comments order:
@class, @abstract, @constructor, @extends, @params.
- Fix indentation errors
A fairly common mistake was a superfluous space before the
identifier on the assignment line directly below the
documentation comment.
$ ack "^ [^*]" --js modules/ve
- Typo "Inhertiance" -> "Inheritance".
- Replacing the other confusing comment "Inheritance" (inside
the constructor) with "Parent constructor".
- Add missing @abstract for ve.ui.Tool.
- Corrected ve.FormatDropdownTool to ve.ui.FormatDropdownTool.js
- Add function names to all @constructor functions. Now that we
have inheritance it is important and useful to have these
functions not be anonymous.
Example of debug shot: http://cl.ly/image/1j3c160w3D45
Makes the difference between
< documentNode;
> ve_dm_DocumentNode
...
: ve_dm_BranchNode
...
: ve_dm_Node
...
: ve_dm_Node
...
: Object
...
without names (current situation):
< documentNode;
> Object
...
: Object
...
: Object
...
: Object
...
: Object
...
though before this commit, it really looks like this
(flattened since ve.extendClass really did a mixin):
< documentNode;
> Object
...
...
...
Pattern in Sublime (case-sensitive) to find nameless
constructor functions:
"^ve\..*\.([A-Z])([^\.]+) = function \("
Change-Id: Iab763954fb8cf375900d7a9a92dec1c755d5407e
2012-09-05 06:07:47 +00:00
|
|
|
|
2012-07-20 23:59:59 +00:00
|
|
|
/* Methods */
|
|
|
|
|
|
2013-08-26 19:47:20 +00:00
|
|
|
/** @inheritdoc */
|
2012-08-01 00:49:04 +00:00
|
|
|
ve.init.mw.Platform.prototype.getExternalLinkUrlProtocolsRegExp = function () {
|
2012-07-20 23:59:59 +00:00
|
|
|
return this.externalLinkUrlProtocolsRegExp;
|
|
|
|
|
};
|
|
|
|
|
|
2015-08-12 20:55:31 +00:00
|
|
|
/** @inheritdoc */
|
|
|
|
|
ve.init.mw.Platform.prototype.getUnanchoredExternalLinkUrlProtocolsRegExp = function () {
|
|
|
|
|
return this.unanchoredExternalLinkUrlProtocolsRegExp;
|
|
|
|
|
};
|
|
|
|
|
|
2018-08-25 15:40:41 +00:00
|
|
|
/** @inheritdoc */
|
|
|
|
|
ve.init.mw.Platform.prototype.notify = function ( message, title, options ) {
|
|
|
|
|
return mw.notify( message, ve.extendObject( { title: title }, options ) );
|
|
|
|
|
};
|
|
|
|
|
|
2016-10-11 19:48:02 +00:00
|
|
|
/**
|
|
|
|
|
* Regular expression matching RESTBase IDs
|
|
|
|
|
*
|
|
|
|
|
* This isn't perfect, see T147607
|
|
|
|
|
*
|
|
|
|
|
* @inheritdoc
|
|
|
|
|
*/
|
|
|
|
|
ve.init.mw.Platform.prototype.getMetadataIdRegExp = function () {
|
2020-06-10 19:31:16 +00:00
|
|
|
return mw.libs.ve.restbaseIdRegExp;
|
2016-10-11 19:48:02 +00:00
|
|
|
};
|
|
|
|
|
|
2013-08-26 19:47:20 +00:00
|
|
|
/** @inheritdoc */
|
2012-08-01 00:49:04 +00:00
|
|
|
ve.init.mw.Platform.prototype.addMessages = function ( messages ) {
|
2012-07-20 23:59:59 +00:00
|
|
|
return mw.messages.set( messages );
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/**
|
2013-08-26 19:47:20 +00:00
|
|
|
* @method
|
|
|
|
|
* @inheritdoc
|
2012-07-20 23:59:59 +00:00
|
|
|
*/
|
2014-07-08 22:33:32 +00:00
|
|
|
ve.init.mw.Platform.prototype.getMessage = mw.msg.bind( mw );
|
2012-07-20 23:59:59 +00:00
|
|
|
|
2020-03-16 22:01:51 +00:00
|
|
|
/**
|
|
|
|
|
* @method
|
|
|
|
|
* @inheritdoc
|
|
|
|
|
*/
|
|
|
|
|
ve.init.mw.Platform.prototype.parseNumber = function ( value ) {
|
|
|
|
|
var number = $.tablesorter.getParser( 'number' ).format( value );
|
|
|
|
|
// formatDigit returns -Infinity when parsing fails, change this to NaN
|
|
|
|
|
return number !== -Infinity ? number : NaN;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @method
|
|
|
|
|
* @inheritdoc
|
|
|
|
|
*/
|
|
|
|
|
ve.init.mw.Platform.prototype.formatNumber = function ( number ) {
|
|
|
|
|
return mw.language.convertNumber( number );
|
|
|
|
|
};
|
|
|
|
|
|
2018-06-19 12:30:21 +00:00
|
|
|
/**
|
|
|
|
|
* @inheritdoc
|
|
|
|
|
*/
|
|
|
|
|
ve.init.mw.Platform.prototype.getHtmlMessage = function () {
|
2018-10-28 12:33:31 +00:00
|
|
|
return mw.message.apply( mw.message, arguments ).parseDom().toArray();
|
2018-06-19 12:30:21 +00:00
|
|
|
};
|
|
|
|
|
|
2015-08-28 19:35:56 +00:00
|
|
|
/**
|
|
|
|
|
* @method
|
|
|
|
|
* @inheritdoc
|
|
|
|
|
*/
|
|
|
|
|
ve.init.mw.Platform.prototype.getConfig = mw.config.get.bind( mw.config );
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* All values are JSON-parsed. To get raw values, use mw.user.options.get directly.
|
|
|
|
|
*
|
|
|
|
|
* @inheritdoc
|
|
|
|
|
*/
|
|
|
|
|
ve.init.mw.Platform.prototype.getUserConfig = function ( keys ) {
|
|
|
|
|
var values, parsedValues;
|
|
|
|
|
if ( Array.isArray( keys ) ) {
|
|
|
|
|
values = mw.user.options.get( keys );
|
|
|
|
|
parsedValues = {};
|
|
|
|
|
Object.keys( values ).forEach( function ( value ) {
|
|
|
|
|
parsedValues[ value ] = JSON.parse( values[ value ] );
|
|
|
|
|
} );
|
|
|
|
|
return parsedValues;
|
|
|
|
|
} else {
|
|
|
|
|
try {
|
|
|
|
|
return JSON.parse( mw.user.options.get( keys ) );
|
|
|
|
|
} catch ( e ) {
|
|
|
|
|
// We might encounter an old unencoded value in the store
|
|
|
|
|
return null;
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* Options must be registered in onGetPreferences
|
|
|
|
|
*
|
|
|
|
|
* All values are JSON encoded. To set raw values, use mw.user.options.set directly.
|
|
|
|
|
*
|
|
|
|
|
* @inheritdoc
|
|
|
|
|
*/
|
|
|
|
|
ve.init.mw.Platform.prototype.setUserConfig = function ( keyOrValueMap, value ) {
|
|
|
|
|
var jsonValues, jsonValue;
|
2019-02-02 04:49:22 +00:00
|
|
|
|
|
|
|
|
// T214963: Don't try to set user preferences for logged-out users, it doesn't work
|
|
|
|
|
if ( mw.user.isAnon() ) {
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
|
2015-08-28 19:35:56 +00:00
|
|
|
if ( typeof keyOrValueMap === 'object' ) {
|
|
|
|
|
if ( OO.compare( keyOrValueMap, this.getUserConfig( Object.keys( keyOrValueMap ) ) ) ) {
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
// JSON encode all the values for API storage
|
|
|
|
|
jsonValues = {};
|
|
|
|
|
Object.keys( keyOrValueMap ).forEach( function ( key ) {
|
|
|
|
|
jsonValues[ key ] = JSON.stringify( keyOrValueMap[ key ] );
|
|
|
|
|
} );
|
2018-05-04 13:30:10 +00:00
|
|
|
ve.init.target.getLocalApi().saveOptions( jsonValues );
|
2015-08-28 19:35:56 +00:00
|
|
|
return mw.user.options.set( jsonValues );
|
|
|
|
|
} else {
|
|
|
|
|
if ( value === this.getUserConfig( keyOrValueMap ) ) {
|
|
|
|
|
return false;
|
|
|
|
|
}
|
|
|
|
|
// JSON encode the value for API storage
|
|
|
|
|
jsonValue = JSON.stringify( value );
|
2018-05-04 13:30:10 +00:00
|
|
|
ve.init.target.getLocalApi().saveOption( keyOrValueMap, jsonValue );
|
2015-08-28 19:35:56 +00:00
|
|
|
return mw.user.options.set( keyOrValueMap, jsonValue );
|
|
|
|
|
}
|
|
|
|
|
};
|
|
|
|
|
|
2019-04-24 14:22:19 +00:00
|
|
|
ve.init.mw.Platform.prototype.createLocalStorage = function () {
|
|
|
|
|
return this.createListStorage( mw.storage );
|
2018-02-21 22:58:50 +00:00
|
|
|
};
|
|
|
|
|
|
2019-04-24 14:22:19 +00:00
|
|
|
ve.init.mw.Platform.prototype.createSessionStorage = function () {
|
|
|
|
|
return this.createListStorage( mw.storage.session );
|
2018-02-21 22:58:50 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @inheritdoc
|
|
|
|
|
*/
|
2012-12-04 06:56:41 +00:00
|
|
|
ve.init.mw.Platform.prototype.addParsedMessages = function ( messages ) {
|
2015-08-19 18:05:01 +00:00
|
|
|
var key;
|
|
|
|
|
for ( key in messages ) {
|
2015-08-19 17:33:02 +00:00
|
|
|
this.parsedMessages[ key ] = messages[ key ];
|
2012-12-04 06:56:41 +00:00
|
|
|
}
|
|
|
|
|
};
|
|
|
|
|
|
2016-02-20 18:53:54 +00:00
|
|
|
/**
|
|
|
|
|
* @inheritdoc
|
|
|
|
|
*/
|
2012-12-04 06:56:41 +00:00
|
|
|
ve.init.mw.Platform.prototype.getParsedMessage = function ( key ) {
|
2014-11-05 20:18:24 +00:00
|
|
|
if ( Object.prototype.hasOwnProperty.call( this.parsedMessages, key ) ) {
|
2013-08-30 00:55:31 +00:00
|
|
|
// Prefer parsed results from VisualEditorDataModule if available.
|
2015-08-19 17:33:02 +00:00
|
|
|
return this.parsedMessages[ key ];
|
2012-12-04 06:56:41 +00:00
|
|
|
}
|
|
|
|
|
// Fallback to regular messages, with mw.message html escaping applied.
|
2019-11-01 16:20:22 +00:00
|
|
|
// eslint-disable-next-line mediawiki/msg-doc
|
2012-12-04 06:56:41 +00:00
|
|
|
return mw.message( key ).escaped();
|
|
|
|
|
};
|
|
|
|
|
|
2016-02-20 18:53:54 +00:00
|
|
|
/**
|
|
|
|
|
* @inheritdoc
|
|
|
|
|
*/
|
2014-06-12 11:48:44 +00:00
|
|
|
ve.init.mw.Platform.prototype.getLanguageCodes = function () {
|
|
|
|
|
return Object.keys(
|
|
|
|
|
mw.language.getData( mw.config.get( 'wgUserLanguage' ), 'languageNames' ) ||
|
|
|
|
|
$.uls.data.getAutonyms()
|
|
|
|
|
);
|
|
|
|
|
};
|
|
|
|
|
|
2016-02-20 18:53:54 +00:00
|
|
|
/**
|
|
|
|
|
* @inheritdoc
|
|
|
|
|
*/
|
2014-06-12 11:48:44 +00:00
|
|
|
ve.init.mw.Platform.prototype.getLanguageName = function ( code ) {
|
|
|
|
|
var languageNames = mw.language.getData( mw.config.get( 'wgUserLanguage' ), 'languageNames' ) ||
|
|
|
|
|
$.uls.data.getAutonyms();
|
2020-10-02 13:54:19 +00:00
|
|
|
return languageNames[ code ] || code;
|
2014-06-12 11:48:44 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @method
|
|
|
|
|
* @inheritdoc
|
|
|
|
|
*/
|
2016-02-20 18:53:54 +00:00
|
|
|
ve.init.mw.Platform.prototype.getLanguageAutonym = $.uls.data.getAutonym;
|
2014-06-12 11:48:44 +00:00
|
|
|
|
|
|
|
|
/**
|
|
|
|
|
* @method
|
|
|
|
|
* @inheritdoc
|
|
|
|
|
*/
|
2016-02-20 18:53:54 +00:00
|
|
|
ve.init.mw.Platform.prototype.getLanguageDirection = $.uls.data.getDir;
|
2014-06-12 11:48:44 +00:00
|
|
|
|
2016-02-20 18:53:54 +00:00
|
|
|
/**
|
|
|
|
|
* @method
|
|
|
|
|
* @inheritdoc
|
|
|
|
|
*/
|
|
|
|
|
ve.init.mw.Platform.prototype.getUserLanguages = mw.language.getFallbackLanguageChain;
|
2013-01-15 20:15:15 +00:00
|
|
|
|
2015-03-13 00:51:54 +00:00
|
|
|
/**
|
|
|
|
|
* @inheritdoc
|
|
|
|
|
*/
|
|
|
|
|
ve.init.mw.Platform.prototype.fetchSpecialCharList = function () {
|
2016-03-22 15:05:15 +00:00
|
|
|
return mw.loader.using( 'mediawiki.language.specialCharacters' ).then( function () {
|
2019-02-09 00:59:25 +00:00
|
|
|
var specialCharacterGroups = require( 'mediawiki.language.specialCharacters' ),
|
|
|
|
|
characters = {},
|
2016-03-22 15:05:15 +00:00
|
|
|
otherGroupName = mw.msg( 'visualeditor-special-characters-group-other' ),
|
2017-06-06 10:12:41 +00:00
|
|
|
otherMsg = mw.message( 'visualeditor-quick-access-characters.json' ).plain(),
|
2018-02-28 13:47:51 +00:00
|
|
|
// TODO: This information should be available upstream in mw.language.specialCharacters
|
|
|
|
|
rtlGroups = [ 'arabic', 'arabicextended', 'hebrew' ],
|
2016-06-10 16:02:26 +00:00
|
|
|
other, groupObject;
|
|
|
|
|
|
|
|
|
|
try {
|
|
|
|
|
other = JSON.parse( otherMsg );
|
|
|
|
|
if ( other ) {
|
2020-10-08 18:07:52 +00:00
|
|
|
characters.other = {
|
|
|
|
|
label: otherGroupName,
|
|
|
|
|
characters: other,
|
|
|
|
|
attributes: { dir: mw.config.get( 'wgVisualEditorConfig' ).pageLanguageDir }
|
|
|
|
|
};
|
2016-03-22 15:05:15 +00:00
|
|
|
}
|
2016-06-10 16:02:26 +00:00
|
|
|
} catch ( err ) {
|
|
|
|
|
ve.log( 've.init.mw.Platform: Could not parse the Special Character list.' );
|
|
|
|
|
ve.log( err );
|
2015-03-30 01:47:43 +00:00
|
|
|
}
|
|
|
|
|
|
2019-02-20 20:23:43 +00:00
|
|
|
// eslint-disable-next-line no-jquery/no-each-util
|
2019-02-09 00:59:25 +00:00
|
|
|
$.each( specialCharacterGroups, function ( groupName, groupCharacters ) {
|
2016-03-22 15:05:15 +00:00
|
|
|
groupObject = {}; // button label => character data to insert
|
2019-02-20 20:23:43 +00:00
|
|
|
// eslint-disable-next-line no-jquery/no-each-util
|
2016-03-22 15:05:15 +00:00
|
|
|
$.each( groupCharacters, function ( charKey, charVal ) {
|
|
|
|
|
// VE has a different format and it would be a pain to change it now
|
|
|
|
|
if ( typeof charVal === 'string' ) {
|
|
|
|
|
groupObject[ charVal ] = charVal;
|
|
|
|
|
} else if ( typeof charVal === 'object' && 0 in charVal && 1 in charVal ) {
|
|
|
|
|
groupObject[ charVal[ 0 ] ] = charVal[ 1 ];
|
|
|
|
|
} else {
|
|
|
|
|
groupObject[ charVal.label ] = charVal;
|
|
|
|
|
}
|
|
|
|
|
} );
|
2019-08-28 15:41:19 +00:00
|
|
|
// The following messages are used here:
|
|
|
|
|
// * special-characters-group-arabic
|
|
|
|
|
// * special-characters-group-arabicextended
|
|
|
|
|
// * special-characters-group-bangla
|
|
|
|
|
// * special-characters-group-canadianaboriginal
|
|
|
|
|
// * special-characters-group-cyrillic
|
|
|
|
|
// * special-characters-group-devanagari
|
|
|
|
|
// * special-characters-group-greek
|
|
|
|
|
// * special-characters-group-greekextended
|
|
|
|
|
// * special-characters-group-gujarati
|
|
|
|
|
// * special-characters-group-hebrew
|
|
|
|
|
// * special-characters-group-ipa
|
|
|
|
|
// * special-characters-group-khmer
|
|
|
|
|
// * special-characters-group-lao
|
|
|
|
|
// * special-characters-group-latin
|
|
|
|
|
// * special-characters-group-latinextended
|
|
|
|
|
// * special-characters-group-persian
|
|
|
|
|
// * special-characters-group-sinhala
|
|
|
|
|
// * special-characters-group-symbols
|
|
|
|
|
// * special-characters-group-tamil
|
|
|
|
|
// * special-characters-group-telugu
|
|
|
|
|
// * special-characters-group-thai
|
2020-10-08 18:07:52 +00:00
|
|
|
characters[ groupName ] = {
|
|
|
|
|
label: mw.msg( 'special-characters-group-' + groupName ),
|
|
|
|
|
characters: groupObject,
|
|
|
|
|
attributes: { dir: rtlGroups.indexOf( groupName ) !== -1 ? 'rtl' : 'ltr' }
|
|
|
|
|
};
|
2015-03-13 00:51:54 +00:00
|
|
|
} );
|
|
|
|
|
|
2016-03-22 15:05:15 +00:00
|
|
|
return characters;
|
|
|
|
|
} );
|
2015-03-13 00:51:54 +00:00
|
|
|
};
|