Page MenuHomeWickedGov Phorge
Files F4099385

ve.dm.MWDocumentReferences.js
No OneTemporary
Actions

Size
4 KB
Referenced Files
None
Subscribers
None

ve.dm.MWDocumentReferences.js
View Options

'use strict';
/*!
* @copyright 2024 VisualEditor Team's Cite sub-team and others; see AUTHORS.txt
* @license MIT
*/
/**
* A facade providing a simplified and safe interface to Cite `ref` and
* `references` tags in a document.
*
* @constructor
* @mixes OO.EventEmitter
* @param {ve.dm.Document} doc The document that reference tags will be embedded in.
*/
ve.dm.MWDocumentReferences = function VeDmMWDocumentReferences( doc ) {
// Mixin constructors
OO.EventEmitter.call( this );
// Properties
this.doc = doc;
/**
* Holds the information calculated for each group.
*
* @member {Object.<string, ve.dm.MWGroupReferences>}
*/
this.cachedByGroup = {};
doc.getInternalList().connect( this, { update: 'updateGroups' } );
this.updateAllGroups();
};
/* Inheritance */
OO.mixinClass( ve.dm.MWDocumentReferences, OO.EventEmitter );
/* Methods */
/**
* Singleton MWDocumentReferences for a document.
*
* @param {ve.dm.Document} doc Source document associated with the
* singleton. May be a fragment in which case we only look at refs included in
* the fragment.
*
* @return {ve.dm.MWDocumentReferences} Singleton docRefs
*/
ve.dm.MWDocumentReferences.static.refsForDoc = function ( doc ) {
let docRefs;
if ( !doc.getOriginalDocument() ) {
// Only use cache if we're working with the full document.
docRefs = doc.getStorage( 'document-references-store' );
}
if ( docRefs === undefined ) {
docRefs = new ve.dm.MWDocumentReferences( doc );
}
if ( !doc.getOriginalDocument() ) {
doc.setStorage( 'document-references-store', docRefs );
}
return docRefs;
};
/**
* @private
*/
ve.dm.MWDocumentReferences.prototype.updateAllGroups = function () {
this.updateGroups( this.getAllGroupNames() );
};
/**
* @private
* @param {string[]} groupsChanged A list of group names which have changed in
* this transaction
*/
ve.dm.MWDocumentReferences.prototype.updateGroups = function ( groupsChanged ) {
groupsChanged.forEach( ( groupName ) => this.updateGroup( groupName ) );
};
/**
* @private
* @param {string[]} groupName Name of the reference group which needs to be
* updated, with prefix
*/
ve.dm.MWDocumentReferences.prototype.updateGroup = function ( groupName ) {
const nodeGroup = this.doc.getInternalList().getNodeGroup( groupName );
this.cachedByGroup[ groupName ] = ve.dm.MWGroupReferences.static.makeGroupRefs( nodeGroup );
};
/**
* @param {string} groupName with or without prefix
* @return {ve.dm.MWGroupReferences}
*/
ve.dm.MWDocumentReferences.prototype.getGroupRefs = function ( groupName ) {
return this.cachedByGroup[ groupName.startsWith( 'mwReference/' ) ? groupName : 'mwReference/' + groupName ] ||
new ve.dm.MWGroupReferences();
};
ve.dm.MWDocumentReferences.prototype.getAllGroupNames = function () {
return Object.keys( this.doc.getInternalList().getNodeGroups() );
};
ve.dm.MWDocumentReferences.prototype.hasRefs = function () {
return this.getAllGroupNames().some( ( groupName ) => !this.getGroupRefs( groupName ).isEmpty() );
};
/**
* Return a formatted number, in the content script, with no separators.
*
* Partial clone of mw.language.convertNumber .
*
* @param {number} num
* @return {string}
*/
ve.dm.MWDocumentReferences.static.contentLangDigits = function ( num ) {
const contentLang = mw.config.get( 'wgContentLanguage' );
const digitLookup = mw.config.get( 'wgTranslateNumerals' ) &&
mw.language.getData( contentLang, 'digitTransformTable' );
const numString = String( num );
if ( !digitLookup ) {
return numString;
}
return numString.split( '' ).map( ( numChar ) => digitLookup[ numChar ] ).join( '' );
};
/**
* @deprecated Should be refactored to store formatted index numbers as a simple
* property on each CE ref node after document transaction.
* @param {string} groupName Ref group without prefix
* @param {string} listKey Ref key with prefix
* @return {string} Rendered index number string which can be used as a footnote
* marker or reflist item number.
*/
ve.dm.MWDocumentReferences.prototype.getIndexLabel = function ( groupName, listKey ) {
return this.getGroupRefs( groupName ).getIndexLabel( listKey );
};

File Metadata

Mime Type
text/plain
Expires
Tue, Aug 18, 15:49 (3 w, 5 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
2d/bc/b13c5a8a99c7b0b515f5d9b8a90d
Default Alt Text
ve.dm.MWDocumentReferences.js (4 KB)

Event Timeline