Copyright test
[jalview.git] / src / com / stevesoft / pat / End.java
1 /*******************************************************************************
2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
3  * Copyright (C) $(date) The Jalview Authors
4  *
5  * This file is part of Jalview.
6  *  
7  * Jalview is free software: you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License 
9  * as published by the Free Software Foundation, either version 3
10  * of the License, or (at your option) any later version.
11  *   
12  * Jalview is distributed in the hope that it will be useful, but 
13  * WITHOUT ANY WARRANTY; without even the implied warranty 
14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR 
15  * PURPOSE.  See the GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
19  * The Jalview Authors are detailed in the 'AUTHORS' file.
20  *******************************************************************************/
21 //
22 // This software is now distributed according to
23 // the Lesser Gnu Public License.  Please see
24 // http://www.gnu.org/copyleft/lesser.txt for
25 // the details.
26 //    -- Happy Computing!
27 //
28 package com.stevesoft.pat;
29
30 import java.util.Hashtable;
31
32 //class AddToEnd extends RegSyntax {};
33
34 /**
35  * Compiles the '$' or the '\Z' Pattern. It is an error to have further Pattern
36  * elements after '\Z'. It is the end of the String.
37  */
38 class End extends Pattern
39 {
40   boolean retIsEnd;
41
42   End(boolean b)
43   {
44     retIsEnd = b;
45   }
46
47   public int matchInternal(int pos, Pthings pt)
48   {
49     if (retIsEnd && pt.mFlag && pos < pt.src.length())
50     {
51       if (pt.src.charAt(pos) == '\n')
52       {
53         return nextMatch(pos, pt);
54       }
55     }
56     if (pt.src.length() == pos)
57     {
58       return nextMatch(pos, pt);
59     }
60     else if (pos < pt.src.length())
61     {
62       // Access the next character...
63       // this is crucial to making
64       // RegexReader work.
65       pt.src.charAt(pos);
66     }
67     return -1;
68   }
69
70   public String toString()
71   {
72     if (retIsEnd)
73     {
74       return "$";
75     }
76     else
77     {
78       return "\\Z";
79     }
80   }
81
82   public patInt maxChars()
83   {
84     return new patInt(1);
85   }
86
87   public Pattern clone1(Hashtable h)
88   {
89     return new End(retIsEnd);
90   }
91 };