faef2ffbac1242c3ee6088556548730da0f65741
[SXSI/XMLTree.git] / libcds / src / utils / alphabet_mapper.h
1 /* alphabet_mapper.h
2  * Copyright (C) 2008, Francisco Claude, all rights reserved.
3  *
4  * static_bitsequence definition
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2.1 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the Free Software
18  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
19  *
20  */
21
22 #ifndef _ALPHABET_MAPPER_H
23 #define _ALPHABET_MAPPER_H
24
25 #include <basics.h>
26 #include <iostream>
27
28 #define ALPHABET_MAPPER_NONE_HDR 2
29 #define ALPHABET_MAPPER_CONT_HDR 3
30
31 using namespace std;
32
33 /** Base class for alphabet mappers
34  * 
35  *  @author Francisco Claude
36  */
37 class alphabet_mapper {
38   public:
39                 alphabet_mapper();
40     virtual ~alphabet_mapper() {}
41     /** Maps the symbol */
42     virtual uint map(uint s)=0;
43     /** Unmaps the symbol */
44     virtual uint unmap(uint s)=0;
45     /** Returns the size of the mapper */
46     virtual uint size()=0;
47     /** Saves the mapper to a file */
48     virtual uint save(FILE *fp)=0;
49     /** Loads the mapper from a file */
50     static alphabet_mapper * load(FILE * fp);
51                 virtual void use();
52                 virtual void unuse();
53         protected:
54                 uint user_count;
55 };
56
57 #include <alphabet_mapper_none.h>
58 #include <alphabet_mapper_cont.h>
59
60 #endif /* _ALPHABET_MAPPER_H */