001 
002 /*
003  *  JScripter Standard 1.0 - To Script In Java
004  *  Copyright (C) 2008-2011  J.J.Liu<jianjunliu@126.com> <http://www.jscripter.org>
005  *  
006  *  This program is free software: you can redistribute it and/or modify
007  *  it under the terms of the GNU Affero General Public License as published by
008  *  the Free Software Foundation, either version 3 of the License, or
009  *  (at your option) any later version.
010  *  
011  *  This program is distributed in the hope that it will be useful,
012  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
013  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
014  *  GNU Affero General Public License for more details.
015  *  
016  *  You should have received a copy of the GNU Affero General Public License
017  *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
018  */
019 
020 package js.user;
021 
022 import js.*;
023 import js.core.*;
024 
025 /**
026  * <p>An <b>opaque</b> class representing JavaScript client-side <tt>Notation</tt> nodes.</p>
027  * <p>This class represents a notation declared in the DTD. Programmers working exclusively 
028  * with HTML documents never need to use this class. A notation either declares, by 
029  * name, the format of an unparsed entity, or is used for formal declaration of 
030  * processing instruction targets.</p>
031  * <p>The inherited {@link JsNode#nodeName} attribute is set to the declared name of 
032  * the notation.</p>
033  * <p>The DOM Level 1 does not support editing {@link JsNotation} nodes. They are 
034  * therefore read-only.</p>
035  * <p>A {@link JsNotation} node does not have any parent, that is, {@link JsNode#parentNode} 
036  * property for a {@link JsNotation} node is always <tt>null</tt>.</p>
037  * <p>Note that main-stream web browsers do not support the <tt>Notation</tt> interface 
038  * declared by the DOM Core Specification. This <b>opaque</b> class inherits directly 
039  * from {@link JsNode} and for documentation purpose only.</p>
040  *
041  * @author <a href="mailto:jianjunliu@126.com">J.J.Liu (Jianjun Liu)</a> at <a href="http://www.jscripter.org" target="_blank">http://www.jscripter.org</a>
042  *
043  * @javascript <b>Opaque</b> types can be resolved but no class objects for them can be
044  * generated into the target codes. Re-compilers must exit with error on the operations of
045  * accessing that kind of class objects.
046  * The <tt>checkcast</tt> operation to the class literal of this interface must be ignored
047  * and <tt>instanceof</tt> to it always <tt>true</tt>.
048  */
049 public class JsNotation extends JsNode
050 {
051     /**
052      * <p>An <b>internal</b> class containing membership data for its enclosing
053      * opaque class.</p>
054      * <p>This class is only used inside of <b>opaque</b> or <b>internal</b> classes or
055      * class members.</p>
056      *
057      * @author <a href="mailto:jianjunliu@126.com">J.J.Liu (Jianjun Liu)</a> at <a href="http://www.jscripter.org" target="_blank">http://www.jscripter.org</a>
058      * 
059      * @javascript Re-compilers must report error on resolving an <b>internal</b> class.
060      */
061     protected static abstract class Members extends JsClient.Node.Prototype.Members
062     {
063         /**
064          * <p>An <b>internal</b> static field defining a member ID of the field name and
065          * used internally to define a member of the same name.</p>
066          * @since 1.0
067          * @see JsNotation#publicId
068          * @see JsNotation.Member#publicId
069          * @javascript Re-compilers must report error on accessing an <b>internal</b> field.
070          */
071         public final static Mid publicId = id("publicId");
072         /**
073          * <p>An <b>internal</b> static field defining a member ID of the field name and
074          * used internally to define a member of the same name.</p>
075          * @since 1.0
076          * @see JsNotation#systemId
077          * @see JsNotation.Member#systemId
078          * @javascript Re-compilers must report error on accessing an <b>internal</b> field.
079          */
080         public final static Mid systemId = id("systemId");
081     }
082     /**
083      * <p>An <b>opaque</b> class representing members of its enclosing <b>opaque</b> type.</p>
084      * <p>Note that, this class is <b>opaque</b> but its constructors are all <b>internal</b>. 
085      * This class and the subclasses of this class are used to declare either <b>opaque</b> 
086      * <tt>public</tt> instance fields of the opaque type {@link js.Var.Member} or the 
087      * <b>opaque</b> <tt>public</tt> static fields of other <b>opaque</b> types while their 
088      * constructors are used to define the fields inside <b>opaque</b> classes. Under 
089      * either circumstance, the field names must be exactly same as the member names, as 
090      * the <b>opaque</b> fields of <b>opaque</b> types are resolved by re-compilers directly 
091      * based on the field names.</p>
092      *
093      * @author <a href="mailto:jianjunliu@126.com">J.J.Liu (Jianjun Liu)</a> at <a href="http://www.jscripter.org" target="_blank">http://www.jscripter.org</a>
094      * 
095      * @javascript <b>Opaque</b> types can be resolved but no class objects for them can be created
096      * in the target codes. Re-compilers must exit with error on operations accessing that kind 
097      * of class objects.
098      * Re-compilers must resolve an <b>opaque</b> instance field declared by this class in
099      * {@link js.Var.Member} or its subclasses to the JavaScript identifier: 
100      * <pre>q.m</pre>
101      * where <tt>m</tt> is the identifier of the field name and <tt>q</tt> is the identifier
102      * resolved from the instance of the enclosing member. Re-compilers must resolve an 
103      * <b>opaque</b> static field declared by this class in <b>opaque</b> types other than 
104      * {@link js.Var.Member} and its subclasses to the JavaScript identifier: 
105      * <pre>m</pre>
106      * where <tt>m</tt> is the identifier of the field name. And re-compilers must report
107      * error on the access to <b>opaque</b> fields declared by this class under any other 
108      * circumstances.
109      */
110     public static class Member extends JsClient.Node.Prototype.Member
111     {
112         /**
113          * <p>Internally constructs a member based on a qualifying member.</p>
114          * <p>This constructor is <b>internal</b> and only called inside of <b>opaque</b>
115          * or <b>internal</b> classes or class members.</p>
116          * <p>Note that, this constructor is <b>internal</b> but its declaring class is
117          * <b>opaque</b>. This constructor is used to define <b>opaque</b> instance fields 
118          * declared in the declaring class of this constructor itself or its subclasses. 
119          * Under this circumstance, the field names must be exactly same as the member 
120          * names, as the <b>opaque</b> instance fields of the <b>opaque</b> type 
121          * {@link js.Var.Member} or its subclasses are resolved by re-compilers directly
122          * to their names appending to the name resolved from the specified qualifying 
123          * member with a dot in between.</p>
124          * @param q A qualifying member
125          * @param mid The ID of the member to construct
126          * @since 1.0
127          * @javascript Re-compilers must report error on the invocation to an <b>internal</b> constructor.
128          */
129         public Member(JsObject.Member q, Mid mid) {
130             super(q, mid);
131         }
132         /**
133          * <p>Internally constructs a member without a qualifying member.</p>
134          * <p>This constructor is <b>internal</b> and only called inside of <b>opaque</b>
135          * or <b>internal</b> classes or class members.</p>
136          * <p>Note that, this constructor is <b>internal</b> but its declaring class is
137          * <b>opaque</b>. This constructor is used to define <b>opaque</b> static fields, 
138          * declared in <b>opaque</b> types other than the declaring class of this constructor 
139          * itself and its subclasses. Under this circumstance, the field names must be
140          * exactly same as the member names, as the <b>opaque</b> static fields of <b>opaque</b>
141          * types are generally resolved by re-compilers directly to identifiers of their names.</p>
142          * @param mid The ID of the member to construct
143          * @since 1.0
144          * @javascript Re-compilers must report error on the invocation to an <b>internal</b> constructor.
145          */
146         public Member(Mid mid) {
147             super(mid);
148         }
149         @Override
150         /**
151          * <p>Evaluates the property, represented by the current member instance, of the
152          * argument object.</p>
153          * @param o The argument object
154          * @return The value of the current member based on the object argument.
155          * @since 1.0
156          * @javascript Re-compilers must convert the instance invocation of this method into
157          * the JavaScript expression: 
158          * <pre>o.m</pre>
159          * where <tt>m</tt> is the identifier name resolved from the current member
160          * instance of the invocation.
161          */
162         public JsNotation with(ObjectLike o) {
163             return new JsNotation(super.with(o));
164         }
165 
166         /**
167          * <p>An <b>opaque</b> instance field defining a sub-member that is named by the
168          * name of this field, qualified by the current member instance of the field, and 
169          * to access the property of the name on an object.</p>
170          * <p>The property, identified by this member, of a {@link JsNotation} object 
171          * refers to a read-only string specifying the public identifier of this 
172          * notation. If the public identifier was not specified, this is <tt>null</tt>.</p>
173          * @since 1.0
174          * @javascript Re-compilers must resolve the member of this instance field to the
175          * identifier of the field name appending to the identifier resolved from its 
176          * qualifying member with a dot in between.
177          */
178         public final Value.String.Member publicId = new Value.String.Member(this, Members.publicId);
179         /**
180          * <p>An <b>opaque</b> instance field defining a sub-member that is named by the
181          * name of this field, qualified by the current member instance of the field, and 
182          * to access the property of the name on an object.</p>
183          * <p>The property, identified by this member, of a {@link JsNotation} object 
184          * refers to a read-only string specifying the system identifier of this 
185          * notation. If the system identifier was not specified, this is <tt>null</tt>.</p>
186          * @since 1.0
187          * @javascript Re-compilers must resolve the member of this instance field to the
188          * identifier of the field name appending to the identifier resolved from its 
189          * qualifying member with a dot in between.
190          */
191         public final Value.String.Member systemId = new Value.String.Member(this, Members.systemId);
192     }
193 
194     /**
195      * <p>Casts an <b>opaque</b> object to the current <b>opaque</b> type by wrapping it
196      * with the wrapping constructor.</p>
197      * @param var The argument of an <b>opaque</b> object.
198      * @since 1.0
199      * @javascript Re-compilers must ignore the construction operation of this constructor,
200      * that is, replacing it with its only argument.
201      */
202     public JsNotation(JsObject var) {
203         super(var);
204     }
205 
206     /**
207      * <p>An <b>opaque</b> static field defining a member that is named by the field name
208      * without a qualifying member and to access the property of the name on an object.</p>
209      * <p>The property, identified by this member, of a {@link JsNotation} object 
210      * refers to a read-only string specifying the public identifier of this 
211      * notation. If the public identifier was not specified, this is <tt>null</tt>.</p>
212      * @since 1.0
213      * @javascript Re-compilers must resolve the member of this static field to the
214      * identifier of the field name.
215      */
216     public static final Value.String.Member publicId = new Value.String.Member(Members.publicId);
217     /**
218      * <p>An <b>opaque</b> static field defining a member that is named by the field name
219      * without a qualifying member and to access the property of the name on an object.</p>
220      * <p>The property, identified by this member, of a {@link JsNotation} object 
221      * refers to a read-only string specifying the system identifier of this 
222      * notation. If the system identifier was not specified, this is <tt>null</tt>.</p>
223      * @since 1.0
224      * @javascript Re-compilers must resolve the member of this static field to the
225      * identifier of the field name.
226      */
227     public static final Value.String.Member systemId = new Value.String.Member(Members.systemId);
228 
229     @Override
230     /**
231      * <p>Returns the primitive value associated with the current instance, if there is one.
232      * This invocation simply returns the instance itself for the current instance is an 
233      * object and there is no primitive value for it.</p>
234      * @return The current object itself.
235      * @since 1.0
236      * @javascript Re-compilers must convert the instance invocation of this method directly
237      * into a JavaScript invocation on its current object instance without changing the 
238      * method name, but expanding variable arguments, if any, into comma-separated values. 
239      */
240     public JsNotation valueOf() {
241         return new JsNotation((JsObject)var().valueOf());
242     }
243 }