gnustep/libs-base
0
0
Fork 0
mirror of https://github.com/gnustep/libs-base.git synced 2025-04-22 16:33:29 +00:00
Code Issues Projects Releases Packages Wiki Activity

Improve markup for overriding methods

Browse source 
git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@22110 72102866-910b-0410-8b05-ffd578937521
This commit is contained in:
Richard Frith-Macdonald 2005-11-28 12:59:59 +00:00
parent 80dc6f2589
commit 78c6273ee1
6 changed files with 675 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
ChangeLog
View file

@ -3,8 +3,14 @@
* Tools/AGSOutput.m:
* Tools/AGSParser.h:
* Tools/AGSParser.m:
* Tools/AGSHtml.m:
* Tools/autogsdoc.m:
* Tools/gsdoc-1_0_3.dtd:
* Toold/gsdoc.gsdoc:
Added override=dummy attribute for methods which have dummy
implementations intendeed to be ocerridden in subclasses.
Update to log warning about unimplemented methods which are not
tagged as "<override-subclass />". ie intentionally empty.
tagged as intended to be overridden.
2005-11-22 Richard Frith-Macdonald <rfm@gnu.org>

5
Tools/AGSHtml.m
View file

@ -1621,6 +1621,11 @@ static NSString *mainFont = nil;
[buf appendString: @"Subclasses <strong>should</strong> "
@"override this method.<br />\n"];
}
else if ([str isEqual: @"dummy"] == YES)
{
[buf appendString: @"An empty method provided for subclasses "
@"to override.<br />\n"];
}
else if ([str isEqual: @"never"] == YES)
{
[buf appendString: @"Subclasses should <strong>NOT</strong> "

27
Tools/AGSOutput.m
View file

@ -331,8 +331,8 @@ static BOOL snuggleStart(NSString *t)
[str appendString: @"<?xml version=\"1.0\"?>\n"];
[str appendString: @"<!DOCTYPE gsdoc PUBLIC "];
[str appendString: @"\"-//GNUstep//DTD gsdoc 1.0.2//EN\" "];
[str appendString: @"\"http://www.gnustep.org/gsdoc-1_0_2.xml\">\n"];
[str appendString: @"\"-//GNUstep//DTD gsdoc 1.0.3//EN\" "];
[str appendString: @"\"http://www.gnustep.org/gsdoc-1_0_3.xml\">\n"];
[str appendFormat: @"<gsdoc"];
if (base != nil)
@ -1025,6 +1025,29 @@ static BOOL snuggleStart(NSString *t)
[d setObject: @"NO" forKey: @"Empty"];
}
} while (r.length > 0);
do
{
r = [comment rangeOfString: @"<override-dummy />"];
if (r.length == 0)
r = [comment rangeOfString: @"<override-dummy/>"];
if (r.length == 0)
r = [comment rangeOfString: @"<override-dummy>"];
if (r.length > 0)
{
if (m == nil)
{
m = [comment mutableCopy];
}
[m deleteCharactersInRange: r];
comment = m;
override = @"dummy";
/*
* If a method should be overridden by subclasses,
* we don't treat it as unimplemented.
*/
[d setObject: @"NO" forKey: @"Empty"];
}
} while (r.length > 0);
do
{
r = [comment rangeOfString: @"<override-never />"];

5
Tools/autogsdoc.m
View file

@ -203,6 +203,11 @@
The method is marked as being one which subclasses must override
(e.g. an abstract method).
</item>
<item><strong>&lt;override-dummy /&gt;</strong>
The method is marked as being one which is a dummy implementation
intended for subclasses to override, though not one they are forced
to implement.
</item>
<item><strong>&lt;override-never /&gt;</strong>
The method is marked as being one which subclasses should <em>NOT</em>
override.

626
Tools/gsdoc-1_0_3.dtd Normal file
View file

@ -0,0 +1,626 @@
<!--
XML Document Type Definition for GNUstep Documentation Markup
Language (gsdoc).
Written by Richard Frith-Macdonald
Based on GDML by 1997 Yoo C. Chung
This is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later
version.
This document is distributed in the hope that it will be
useful, but WITHOUT ANY WARRANTY; without even the implied
warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General
Public License along with this software; if not, write to the
Free Software Foundation, Inc., 675 Mass Ave, Cambridge, MA
02139, USA.
-->
<!--
gsdoc is an XML language - Typical usage:
<?xml version="1.0"?>
<!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 1.0.3//EN"
"http://www.gnustep.org/gsdoc.xml">
<gsdoc base="myDocName">
</gsdoc>
-->
<!--***** Character entities. *****-->
<!-- General purpose characters for gsdoc. -->
<!ENTITY copy "&#169;"> <!-- copyright symbol -->
<!ENTITY tm "&#174;"> <!-- trademark symbol -->
<!ENTITY reg "&#174;">
<!ENTITY dots "&#8230;"> <!-- ellipsis (...) -->
<!ENTITY nbsp "&#160;"> <!-- non breakable space -->
<!ENTITY amp "&#38;#38;"> <!-- ampersand -->
<!ENTITY apos "&#39;"> <!-- apos -->
<!ENTITY quot "&#34;"> <!-- quotation mark (") -->
<!ENTITY lt "&#38;#60;"> <!-- lesser than symbol -->
<!ENTITY gt "&#62;"> <!-- greater than symbol -->
<!--***** Entity declarations. *****-->
<!-- Boolean values for attributes -->
<!ENTITY % boolean "(yes|no)">
<!-- Entity for phrase elements. -->
<!ENTITY % phrase "var | ivar | em | code | strong | file | site">
<!-- Entity for cross references. -->
<!ENTITY % xref "ref | uref | url | email | prjref">
<!-- Entity for anchors. -->
<!ENTITY % anchor "label | entry">
<!-- Entity for simple text level elements. -->
<!ENTITY % text "#PCDATA | %xref; | %anchor; | %phrase; | footnote | br">
<!-- Entity for list elements. -->
<!ENTITY % list "list | enum | deflist | qalist | dictionary">
<!-- Entity for block level elements. -->
<!ENTITY % block "%text; | %list; | p | example | embed | index">
<!-- Entity for definition elements and blocks. -->
<!ENTITY % defblock "%text; | %list; | heading | p | example | embed | index | class | category | protocol | function | macro | type | variable | constant | EOModel | EOEntity">
<!--**********-->
<!-- Used for describing something. -->
<!ELEMENT desc (%block;)*>
<!-- A footnote. -->
<!ELEMENT footnote (%text;)*>
<!--***** Phrase elements. *****-->
<!-- The content is a metasyntactic variable or argument name. -->
<!ELEMENT var (%text;)*>
<!-- The content is a metasyntactic ivariable name. -->
<!ELEMENT ivar (%text;)*>
<!-- Emphasize the content. -->
<!ELEMENT em (%text;)*>
<!-- The content is too important that simple emphasizing isn't
enough. -->
<!ELEMENT strong (%text;)*>
<!-- The content is either a name for code (e.g. class names), or a
relatively short code fragment. -->
<!ELEMENT code (%text;)*>
<!-- The content is a file name. -->
<!ELEMENT file (#PCDATA)*>
<!-- The content is a fully qualified domain name on the Internet. -->
<!ELEMENT site (#PCDATA)*>
<!--***** List elements. *****-->
<!-- An item in a list. -->
<!ELEMENT item (%block;)*>
<!-- An enumerated list. -->
<!ELEMENT enum (item+)>
<!-- A ordinary, unnumbered list. -->
<!ELEMENT list (item+)>
<!-- A term to defined in a definition list. -->
<!ELEMENT term (%text;)*>
<!-- A definition list. -->
<!ELEMENT deflist (term, desc)+>
<!-- A question for a question and answer list. -->
<!ELEMENT question (%text;)*>
<!-- An answer for a question and answer list. -->
<!ELEMENT answer (%block;)*>
<!-- A question and answer list. -->
<!ELEMENT qalist (question, answer)+>
<!--**********-->
<!--***** Cross references. *****-->
<!-- A reference.
ID of the reference.
TYPE of reference, if implied, a reference to a label.
CLASS specific class for a method, may be one of the following formats -
classname, classname(categoryname), (protocolname)
-->
<!ELEMENT ref (%text;)*>
<!ATTLIST ref
id CDATA #REQUIRED
type (class|category|protocol|method|ivariable|function|type|macro|variable|constant|label|EOModel|EOEntity|tool) "label"
class CDATA #IMPLIED
>
<!-- An e-mail address. -->
<!ELEMENT email (%text;)*>
<!ATTLIST email
address CDATA #IMPLIED
>
<!-- A URL. -->
<!ELEMENT url EMPTY>
<!ATTLIST url
url CDATA #IMPLIED
>
<!-- A reference to a URL.
The text contained appears in the output.
-->
<!ELEMENT uref (%text;)*>
<!ATTLIST uref
url CDATA #REQUIRED
>
<!-- A reference to a project.
The text contained appears in the output.
-->
<!ELEMENT prjref (%text;)*>
<!ATTLIST prjref
prjname CDATA #IMPLIED
file CDATA #IMPLIED
>
<!--***** Anchors. *****-->
<!-- An anchor for a general reference.
The text contained appears in the output.
If the id attribute is omitted, the text is used in its place.
-->
<!ELEMENT label (%text;)*>
<!ATTLIST label
id CDATA #IMPLIED
>
<!-- An entry for the general index.
The text that is contained appears in the index, and never in
the text itself.
If the id attribute is omitted, the text is used in its place.
-->
<!ELEMENT entry (%text;)*>
<!ATTLIST entry
id CDATA #IMPLIED
>
<!-- OBSOLETE ... do not use -->
<!ELEMENT GNUstep EMPTY>
<!ELEMENT OpenStep EMPTY>
<!ELEMENT NotOpenStep EMPTY>
<!ELEMENT MacOS-X EMPTY>
<!ELEMENT NotMacOS-X EMPTY>
<!-- OBSOLETE ... do not use -->
<!ENTITY % standard "GNUstep | OpenStep | NotOpenStep | MacOS-X | NotMacOS-X">
<!-- OBSOLETE ... do not use -->
<!ELEMENT standards (%standard;)*>
<!--***** Argument elements. *****-->
<!-- An argument. -->
<!ELEMENT arg (#PCDATA)*>
<!ATTLIST arg
type CDATA #IMPLIED
>
<!-- Denotes that the rest of the arguments is a variable list,
like in printf().
-->
<!ELEMENT vararg EMPTY>
<!--***** Method elements. *****-->
<!-- A component for a method selector. -->
<!ELEMENT sel (#PCDATA)*>
<!-- A method. If there is no DESC, it is understood that the element
is used to override some information from the same method in the
superclass.
If factory not set, instance method
-->
<!ELEMENT method (((sel, arg?), (sel, arg)*, vararg?), desc?, standards?)>
<!ATTLIST method
type CDATA #IMPLIED
factory %boolean; "no"
init %boolean; "no"
override (subclass|dummy|never) #IMPLIED
gvadd CDATA #IMPLIED
gvdep CDATA #IMPLIED
gvrem CDATA #IMPLIED
ovadd CDATA #IMPLIED
ovdep CDATA #IMPLIED
ovrem CDATA #IMPLIED
>
<!--***** Elements for definitions of classes, functions, etc. *****-->
<!-- Show what header file something lives in. -->
<!ELEMENT declared (#PCDATA)*>
<!-- A macro definition.
-->
<!ELEMENT macro ((arg*, vararg?), declared?, desc?, standards?)>
<!ATTLIST macro
name CDATA #REQUIRED
gvadd CDATA #IMPLIED
gvdep CDATA #IMPLIED
gvrem CDATA #IMPLIED
ovadd CDATA #IMPLIED
ovdep CDATA #IMPLIED
ovrem CDATA #IMPLIED
>
<!-- A type definition.
-->
<!ELEMENT type (declared?, desc?, standards?)>
<!ATTLIST type
name CDATA #REQUIRED
type CDATA #REQUIRED
gvadd CDATA #IMPLIED
gvdep CDATA #IMPLIED
gvrem CDATA #IMPLIED
ovadd CDATA #IMPLIED
ovdep CDATA #IMPLIED
ovrem CDATA #IMPLIED
>
<!-- Variable definition.
VALUE may be set for a constant or a default value
-->
<!ELEMENT variable (declared?, desc?, standards?)>
<!ATTLIST variable
name CDATA #REQUIRED
type CDATA #REQUIRED
value CDATA #IMPLIED
gvadd CDATA #IMPLIED
gvdep CDATA #IMPLIED
gvrem CDATA #IMPLIED
ovadd CDATA #IMPLIED
ovdep CDATA #IMPLIED
ovrem CDATA #IMPLIED
>
<!-- Ivariable definition.
-->
<!ELEMENT ivariable (desc?, standards?)>
<!ATTLIST ivariable
name CDATA #REQUIRED
type CDATA #REQUIRED
validity (public|protected|private) "public"
gvadd CDATA #IMPLIED
gvdep CDATA #IMPLIED
gvrem CDATA #IMPLIED
ovadd CDATA #IMPLIED
ovdep CDATA #IMPLIED
ovrem CDATA #IMPLIED
>
<!-- Constant definition.
VALUE may be set for a constant or a default value
-->
<!ELEMENT constant (declared?, desc?, standards?)>
<!ATTLIST constant
name CDATA #REQUIRED
type CDATA #REQUIRED
value CDATA #IMPLIED
role (except|defaults|notify|key) #IMPLIED
gvadd CDATA #IMPLIED
gvdep CDATA #IMPLIED
gvrem CDATA #IMPLIED
ovadd CDATA #IMPLIED
ovdep CDATA #IMPLIED
ovrem CDATA #IMPLIED
>
<!-- A function definition.
-->
<!ELEMENT function ((arg*, vararg?), declared?, desc?, standards?)>
<!ATTLIST function
name CDATA #REQUIRED
type CDATA #REQUIRED
gvadd CDATA #IMPLIED
gvdep CDATA #IMPLIED
gvrem CDATA #IMPLIED
ovadd CDATA #IMPLIED
ovdep CDATA #IMPLIED
ovrem CDATA #IMPLIED
>
<!-- Protocol definition.
-->
<!ELEMENT protocol (declared?, conform*, desc?, method*, standards?)>
<!ATTLIST protocol
name CDATA #REQUIRED
gvadd CDATA #IMPLIED
gvdep CDATA #IMPLIED
gvrem CDATA #IMPLIED
ovadd CDATA #IMPLIED
ovdep CDATA #IMPLIED
ovrem CDATA #IMPLIED
>
<!-- Category definition.
-->
<!ELEMENT category (declared?, conform*, desc?, method*, standards?)>
<!ATTLIST category
name CDATA #REQUIRED
class CDATA #REQUIRED
gvadd CDATA #IMPLIED
gvdep CDATA #IMPLIED
gvrem CDATA #IMPLIED
ovadd CDATA #IMPLIED
ovdep CDATA #IMPLIED
ovrem CDATA #IMPLIED
>
<!-- Show a protocol a class conforms to.
-->
<!ELEMENT conform (#PCDATA)*>
<!ELEMENT class (declared?, conform*, desc?, ivariable*, method*, standards?)>
<!ATTLIST class
name CDATA #REQUIRED
super CDATA #IMPLIED
gvadd CDATA #IMPLIED
gvdep CDATA #IMPLIED
gvrem CDATA #IMPLIED
ovadd CDATA #IMPLIED
ovdep CDATA #IMPLIED
ovrem CDATA #IMPLIED
>
<!--***** Elements for definitions of EOModels, etc. *****-->
<!-- a dictionary Item. -->
<!ELEMENT dictionaryItem (%block;)*>
<!ATTLIST dictionaryItem
key CDATA #REQUIRED
value CDATA #IMPLIED
>
<!-- a dictionary -->
<!ELEMENT dictionary (dictionaryItem+)>
<!ELEMENT EOConnectionDictionary (dictionaryItem+)>
<!ELEMENT EOUserDictionary (dictionaryItem+)>
<!--***** Elements for definitions of EOModels, etc. *****-->
<!-- EORelationshipComponent -->
<!ELEMENT EORelationshipComponent (EORelationshipComponent*)>
<!ATTLIST EORelationshipComponent
definition CDATA #REQUIRED
>
<!-- EOJoin -->
<!ELEMENT EOJoin (desc?)>
<!ATTLIST EOJoin
relationshipName CDATA #IMPLIED
joinOperator CDATA #REQUIRED
joinSemantic CDATA #REQUIRED
sourceAttribute CDATA #REQUIRED
destinationAttribute CDATA #REQUIRED
>
<!-- EORelationship -->
<!ELEMENT EORelationship ((EORelationshipComponent | (EOJoin*)), EOUserDictionary?, desc?)>
<!ATTLIST EORelationship
entityName CDATA #REQUIRED
destinationEntityName CDATA #REQUIRED
name CDATA #REQUIRED
isToMany CDATA #IMPLIED
>
<!-- EOAttributeRef -->
<!ELEMENT EOAttributeRef EMPTY>
<!ATTLIST EOAttributeRef
name CDATA #REQUIRED
>
<!-- EOPrimaryKeyAttributes -->
<!ELEMENT EOPrimaryKeyAttributes (EOAttributeRef+)>
<!-- EOClassProperties -->
<!ELEMENT EOClassProperties ((EOAttributeRef)+)>
<!-- EOAttributesUsedForLocking -->
<!ELEMENT EOAttributesUsedForLocking (EOAttributeRef+)>
<!-- EOAttribute -->
<!ELEMENT EOAttribute (EOUserDictionary?, desc?)>
<!ATTLIST EOAttribute
columnName CDATA #IMPLIED
definition CDATA #IMPLIED
externalType CDATA #IMPLIED
name CDATA #REQUIRED
valueClassName CDATA #IMPLIED
valueType CDATA #IMPLIED
entityName CDATA #IMPLIED
isReadOnly CDATA #IMPLIED
isDerived CDATA #IMPLIED
isFlattened CDATA #IMPLIED
>
<!-- EOEntity -->
<!ELEMENT EOEntity (EOAttribute*, EOAttributesUsedForLocking?, EOClassProperties?, EOPrimaryKeyAttributes?, EORelationship*, EOUserDictionary?, desc?)>
<!ATTLIST EOEntity
name CDATA #REQUIRED
externalName CDATA #IMPLIED
className CDATA #IMPLIED
modelName CDATA #IMPLIED
isReadOnly CDATA #IMPLIED
>
<!-- EOModel -->
<!ELEMENT EOModel (EOConnectionDictionary?, (EOEntity+ | list), EOUserDictionary?, desc?)>
<!ATTLIST EOModel
name CDATA #REQUIRED
version CDATA #IMPLIED
adaptorName CDATA #REQUIRED
adaptorClassName CDATA #REQUIRED
>
<!--***** Elements for ordinary block level elements. *****-->
<!-- A line break. -->
<!ELEMENT br EMPTY>
<!-- A paragraph. -->
<!ELEMENT p (%text;)*>
<!-- An example. -->
<!ELEMENT example (#PCDATA)*>
<!ATTLIST example
caption CDATA #IMPLIED
>
<!-- An embedded object. If it is of a type that the SGML processor
cannot handle, then use the content, which is ignored otherwise.
refer - method of referring to object (default is file)
src - the reference to the object
type - Internet media type of the objec
title - optional title describing object
-->
<!ELEMENT embed (%block;)*>
<!ATTLIST embed
refer (file|url) #IMPLIED
src CDATA #REQUIRED
type CDATA #IMPLIED
title CDATA #IMPLIED
>
<!--***** Elements for document structure such as chapters. *****-->
<!-- A heading for chapters, sections, ... -->
<!ELEMENT heading (%text;)*>
<!-- A subsubsection. -->
<!ELEMENT subsubsect (%defblock;)*>
<!ATTLIST subsubsect
id CDATA #IMPLIED
>
<!-- A subsection. -->
<!ELEMENT subsect (%defblock; | subsubsect)*>
<!ATTLIST subsect
id CDATA #IMPLIED
>
<!-- A section. -->
<!ELEMENT section (%defblock; | subsect)*>
<!ATTLIST section
id CDATA #IMPLIED
>
<!-- A chapter. -->
<!ELEMENT chapter (%defblock; | section)*>
<!ATTLIST chapter
id CDATA #IMPLIED
>
<!--***** Elements that make searching for things easier. *****-->
<!-- Table of contents. -->
<!ELEMENT contents EMPTY>
<!-- Index ... generates an index of the specified type of elements.
'scope' determines whether the index is generated for the current file
or for the whole of the current project, or for everything the software
can find (global) ... if the document is processed in a standalone manner,
the scope if always file. For method or ivariable indexing, if the index
is inside a class, protocol, or category, only indexes for that unit
should be generated.
'type' determines the type of entry listed in the index. The 'title'
type really only makes sense for a project scope index as it produces
a list of the files in the project (by title).
-->
<!ELEMENT index EMPTY>
<!ATTLIST index
type (class | category | protocol | method | ivariable | function | type | macro | variable | constant | EOModel | EOEntity | label | title | tool) "label"
scope (file | project | global) "file"
style ( normal | bare ) "normal"
target CDATA #IMPLIED
>
<!--***** Elements that describe the document itself. *****-->
<!-- Copyright of the document. -->
<!ELEMENT copy (%text;)*>
<!-- An abstract. -->
<!ELEMENT abstract (%text;)*>
<!-- The version of the document. -->
<!ELEMENT version (%text;)*>
<!-- The date the document was written. -->
<!ELEMENT date (%text;)*>
<!-- An author. -->
<!ELEMENT author (email?, url?, desc?)>
<!ATTLIST author
name CDATA #REQUIRED
>
<!-- The title of the document. -->
<!ELEMENT title (%text;)*>
<!--***** The topmost structures for the document body. *****-->
<!-- Unnumbered parts appearing in the front, such as a preface. -->
<!ELEMENT front (contents?, chapter*)>
<!-- Unnumbered parts appearing in the back, such as an afterword and/or
indices.
-->
<!ELEMENT back (chapter*, index*)>
<!--***** The topmost structures for the document. *****-->
<!-- The head containing general information about the document. -->
<!ELEMENT head (title, author*, version?, date?, abstract?, copy?)>
<!-- The main part of the document. -->
<!ELEMENT body (front?, chapter+, back?)>
<!--**********-->
<!-- The entire document. -->
<!ELEMENT gsdoc (head, body)>
<!ATTLIST gsdoc
base CDATA #IMPLIED
next CDATA #IMPLIED
prev CDATA #IMPLIED
up CDATA #IMPLIED
stylesheeturl CDATA #IMPLIED
>

10
Tools/gsdoc.gsdoc
View file

@ -792,9 +792,13 @@ notice and this notice are preserved.
<code>init</code> attribute (also taking
"<code>yes</code>" / "<code>no</code>") specifies whether this is
the designated constructor. An optional <code>override</code>
attribute specifies whether this method should be overridden
(if "yes" enter "<code>subclass</code>", if "no" enter
"<code>never</code>").
attribute specifies whether this method should be overridden.
If it <em>must</em> be overridden enter "<code>subclass</code>",
if it must <em>not</em> be overridden enter <code>never</code>",
if it is an empty/dummy implementation which is intended to be
overridden enter <code>dummy</ecode>, otherwise (for most methods
which may be but are not particularly designed to be overridden)
leave this attribute unset.
<p>
The elements in a <code>&lt;method&gt;</code> are -
the method's name (in a <ref id="sel">sel</ref> element), the