1 /*
2  * Copyright (c) 2005, 2010, Oracle and/or its affiliates. All rights reserved.
3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4  *
5  * This code is free software; you can redistribute it and/or modify it
6  * under the terms of the GNU General Public License version 2 only, as
7  * published by the Free Software Foundation.  Oracle designates this
8  * particular file as subject to the "Classpath" exception as provided
9  * by Oracle in the LICENSE file that accompanied this code.
10  *
11  * This code is distributed in the hope that it will be useful, but WITHOUT
12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14  * version 2 for more details (a copy is included in the LICENSE file that
15  * accompanied this code).
16  *
17  * You should have received a copy of the GNU General Public License version
18  * 2 along with this work; if not, write to the Free Software Foundation,
19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20  *
21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22  * or visit www.oracle.com if you need additional information or have any
23  * questions.
24  */
25 /*
26  * Copyright (C) 2004-2011
27  *
28  * Permission is hereby granted, free of charge, to any person obtaining a copy
29  * of this software and associated documentation files (the "Software"), to deal
30  * in the Software without restriction, including without limitation the rights
31  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
32  * copies of the Software, and to permit persons to whom the Software is
33  * furnished to do so, subject to the following conditions:
34  *
35  * The above copyright notice and this permission notice shall be included in
36  * all copies or substantial portions of the Software.
37  *
38  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
39  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
40  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
41  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
42  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
43  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
44  * THE SOFTWARE.
45  */
46 package com.sun.xml.internal.rngom.binary;
47 
48 import com.sun.xml.internal.rngom.binary.visitor.PatternFunction;
49 import com.sun.xml.internal.rngom.binary.visitor.PatternVisitor;
50 import org.xml.sax.Locator;
51 import org.xml.sax.SAXException;
52 import org.xml.sax.SAXParseException;
53 
54 public class RefPattern extends Pattern {
55   private Pattern p;
56   private Locator refLoc;
57   private String name;
58   private int checkRecursionDepth = -1;
59   private boolean combineImplicit = false;
60   private byte combineType = COMBINE_NONE;
61   private byte replacementStatus = REPLACEMENT_KEEP;
62   private boolean expanded = false;
63 
64   static final byte REPLACEMENT_KEEP = 0;
65   static final byte REPLACEMENT_REQUIRE = 1;
66   static final byte REPLACEMENT_IGNORE = 2;
67 
68   static final byte COMBINE_NONE = 0;
69   static final byte COMBINE_CHOICE = 1;
70   static final byte COMBINE_INTERLEAVE = 2;
71 
RefPattern(String name)72   RefPattern(String name) {
73     this.name = name;
74   }
75 
getPattern()76   Pattern getPattern() {
77     return p;
78   }
79 
setPattern(Pattern p)80   void setPattern(Pattern p) {
81     this.p = p;
82   }
83 
getRefLocator()84   Locator getRefLocator() {
85     return refLoc;
86   }
87 
setRefLocator(Locator loc)88   void setRefLocator(Locator loc) {
89     this.refLoc = loc;
90   }
91 
92     @Override
checkRecursion(int depth)93   void checkRecursion(int depth) throws SAXException {
94     if (checkRecursionDepth == -1) {
95       checkRecursionDepth = depth;
96       p.checkRecursion(depth);
97       checkRecursionDepth = -2;
98     }
99     else if (depth == checkRecursionDepth)
100       // XXX try to recover from this?
101       throw new SAXParseException(SchemaBuilderImpl.localizer.message("recursive_reference", name),
102                                   refLoc);
103   }
104 
105     @Override
expand(SchemaPatternBuilder b)106   Pattern expand(SchemaPatternBuilder b) {
107     if (!expanded) {
108       p = p.expand(b);
109       expanded = true;
110     }
111     return p;
112   }
113 
samePattern(Pattern other)114   boolean samePattern(Pattern other) {
115     return false;
116   }
117 
accept(PatternVisitor visitor)118   public void accept(PatternVisitor visitor) {
119     p.accept(visitor);
120   }
121 
apply(PatternFunction f)122   public Object apply(PatternFunction f) {
123     return f.caseRef(this);
124   }
125 
getReplacementStatus()126   byte getReplacementStatus() {
127     return replacementStatus;
128   }
129 
setReplacementStatus(byte replacementStatus)130   void setReplacementStatus(byte replacementStatus) {
131     this.replacementStatus = replacementStatus;
132   }
133 
isCombineImplicit()134   boolean isCombineImplicit() {
135     return combineImplicit;
136   }
137 
setCombineImplicit()138   void setCombineImplicit() {
139     combineImplicit = true;
140   }
141 
getCombineType()142   byte getCombineType() {
143     return combineType;
144   }
145 
setCombineType(byte combineType)146   void setCombineType(byte combineType) {
147     this.combineType = combineType;
148   }
149 
getName()150   String getName() {
151     return name;
152   }
153 }
154