View Javadoc

1   /*
2    * $Id: Dictionary.java,v 1.8 2005/10/14 19:02:44 weiju Exp $
3    * 
4    * Created on 24.09.2005
5    * Copyright 2005 by Wei-ju Wu
6    *
7    * This file is part of The Z-machine Preservation Project (ZMPP).
8    *
9    * ZMPP is free software; you can redistribute it and/or modify
10   * it under the terms of the GNU General Public License as published by
11   * the Free Software Foundation; either version 2 of the License, or
12   * (at your option) any later version.
13   *
14   * ZMPP is distributed in the hope that it will be useful,
15   * but WITHOUT ANY WARRANTY; without even the implied warranty of
16   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17   * GNU General Public License for more details.
18   *
19   * You should have received a copy of the GNU General Public License
20   * along with ZMPP; if not, write to the Free Software
21   * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
22   */
23  package org.zmpp.vm;
24  
25  
26  /***
27   * This is the interface definition for a dictionary.
28   *
29   * @author Wei-ju Wu
30   * @version 1.0
31   */
32  public interface Dictionary {
33  
34    /***
35     * Returns the number of separators.
36     * 
37     * @return the number of separators
38     */
39    int getNumberOfSeparators();
40    
41    /***
42     * Returns the separator at position i as a ZSCII character.
43     * 
44     * @param i the separator number, zero-based
45     * @return the separator
46     */
47    byte getSeparator(int i);
48    
49    /***
50     * Returns the length of a dictionary entry.
51     * 
52     * @return the entry length
53     */
54    int getEntryLength();
55    
56    /***
57     * Returns the number of dictionary entries.
58     * 
59     * @return the number of entries
60     */
61    int getNumberOfEntries();
62    
63    /***
64     * Returns the entry address at the specified position.
65     * 
66     * @param entryNum entry number between (0 - getNumberOfEntries() - 1)
67     * @return the entry address
68     */
69    int getEntryAddress(int entryNum);
70    
71    /***
72     * Looks up a string in the dictionary. The word will be truncated to
73     * the maximum word length and looked up. The result is the address
74     * of the entry or 0 if it is not found.
75     * 
76     * @param token a token
77     * @return the address of the token or 0
78     */
79    int lookup(String token);
80  }