trunk/Src/wptNLS.c

/* wptNLS.cpp - W32 Native Language Support
 *      Copyright (C) 2001, 2002, 2003 Timo Schulz
 *      Copyright (C) 1995-1999 Free Software Foundation, Inc.
 *
 * This code based on the simple-gettext.c code from the GnuPG 
 * by Ulrich Drepper.
 *
 * WinPT is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License 
 * as published by the Free Software Foundation; either version 2 
 * of the License, or (at your option) any later version.
 *  
 * WinPT is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License 
 * along with WinPT; if not, write to the Free Software Foundation,
 * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA 
 */
/* x-todo-status: OK */

#include <stdio.h>
#include <string.h>
#include <ctype.h>
#include <errno.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <windows.h>

#include "wptTypes.h"
#include "wptNLS.h"


/* Missing W32 functions. */
static char *
stpcpy( char *a,const char *b )
{
    while( *b )
        *a++ = *b++;
    *a = 0;
    return (char*)a;
}

/* The magic number of the GNU message catalog format.  */
#define MAGIC         0x950412de
#define MAGIC_SWAPPED 0xde120495

/* Revision number of the currently used .mo (binary) file format.  */
#define MO_REVISION_NUMBER 0


/* Header for binary .mo file format.  */
struct mo_file_header {
  u32 magic; /* The magic number.       */  
  u32 revision; /* The revision number of the file format.  */
  u32 nstrings; /* The number of strings pairs.  */  
  u32 orig_tab_offset; /* Offset of table with start offsets of original 
                          strings.  */
  u32 trans_tab_offset; /* Offset of table with start offsets of translation
                           strings.  */  
  u32 hash_tab_size; /* Size of hashing table.  */  
  u32 hash_tab_offset; /* Offset of first hashing entry.  */
};

struct string_desc {
  u32 length; /* Length of addressed string.  */  
  u32 offset; /* Offset of string in file.      */
};

struct loaded_domain {
  char *data;
  int must_swap;
  u32 nstrings;
  char *mapped;
  struct string_desc *orig_tab;
  struct string_desc *trans_tab;
  u32 hash_size;
  u32 *hash_tab;
};

static struct loaded_domain *the_domain;

static u32
do_swap_u32( u32 i )
{
  return (i << 24) | ((i & 0xff00) << 8) | ((i >> 8) & 0xff00) | (i >> 24);
}

#define SWAPIT(flag, data) ((flag) ? do_swap_u32(data) : (data) )


/* We assume to have `unsigned long int' value with at least 32 bits.  */
#define HASHWORDBITS 32

/* The so called `hashpjw' function by P.J. Weinberger
   [see Aho/Sethi/Ullman, COMPILERS: Principles, Techniques and Tools,
   1986, 1987 Bell Telephone Laboratories, Inc.]  */

static u32
hash_string( const char *str_param )
{
    unsigned long int hval, g;
    const char *str = str_param;

    hval = 0;
    while (*str != '\0') {
        hval <<= 4;
        hval += (unsigned long int) *str++;     
        g = hval & ((unsigned long int) 0xf << (HASHWORDBITS - 4));
        if (g != 0) {
            hval ^= g >> (HASHWORDBITS - 8);
            hval ^= g;  
        }
    }
    return hval;
} /* hash_string */


static struct loaded_domain *
load_domain( const char *filename )
{
    FILE *fp;
    size_t size;
    struct stat st;
    struct mo_file_header *data = NULL;
    struct loaded_domain *domain = NULL;
    size_t to_read;
    char *read_ptr;

    fp = fopen( filename, "rb" );
    if( !fp )
       return NULL; /* can't open the file */
    /* we must know about the size of the file */
    if( fstat( fileno(fp ), &st )
        || (size = (size_t)st.st_size) != st.st_size
        || size < sizeof (struct mo_file_header) ) {
        fclose( fp );   
        return NULL;
    }

    data = (struct mo_file_header *) malloc( size );
    if( !data ) {
        fclose( fp );
        return NULL; /* out of memory */
    }

    to_read = size;
    read_ptr = (char *) data;
    do {
        long int nb = fread( read_ptr, 1, to_read, fp );
        if( nb < to_read ) {
            fclose (fp);
            free(data); 
            return NULL; /* read error */
                
        }
        read_ptr += nb; 
        to_read -= nb;
    } while( to_read > 0 );
    fclose (fp);

    /* Using the magic number we can test whether it really is a message
     * catalog file.  */
    if( data->magic != MAGIC && data->magic != MAGIC_SWAPPED ) {
        /* The magic number is wrong: not a message catalog file.  */
        free( data );
        return NULL;
    }

    domain = (struct loaded_domain *)calloc( 1, sizeof *domain );
    if( !domain )  {
        free( data );   
        return NULL;
    }
    domain->data = (char *) data;
    domain->must_swap = data->magic != MAGIC;

    /* Fill in the information about the available tables.  */
    switch( SWAPIT(domain->must_swap, data->revision) ) {
      case 0:
          domain->nstrings = SWAPIT(domain->must_swap, data->nstrings);
          domain->orig_tab = (struct string_desc *)
              ((char *) data + SWAPIT(domain->must_swap, data->orig_tab_offset));
          domain->trans_tab = (struct string_desc *)
              ((char *) data + SWAPIT(domain->must_swap, data->trans_tab_offset));
          domain->hash_size = SWAPIT(domain->must_swap, data->hash_tab_size);   
          domain->hash_tab = (u32 *)    
              ((char *) data + SWAPIT(domain->must_swap, data->hash_tab_offset));       
          break;

      default: /* This is an invalid revision.  */
          free( data );
          free( domain );
          return NULL;
    }

    /* allocate an array to keep track of code page mappings */
    domain->mapped = (char *)calloc( 1, domain->nstrings );
    if( !domain->mapped ) {
        free( data );
        free( domain ); 
        return NULL;
    }

    return domain;
} /* load_domain */


/****************
 * Set the file used for translations.  Pass a NULL to disable
 * translation.  A new filename may be set at anytime.
 * WARNING: After changing the filename you shoudl not access any data
 *          retrieved by gettext().
 */
int
set_gettext_file( const char *filename, const char *nls_dir )
{
    struct loaded_domain *domain = NULL;

    if( filename && *filename ) {
        if( filename[0] == '/'     
            || ( isalpha(filename[0])            
            && filename[1] == ':'       
            && (filename[2] == '/' || filename[2] == '\\') )
           ) {
            /* absolute path - use it as is */      
            domain = load_domain( filename );
        }
        else { /* relative path - append ".mo" and get dir from the environment */
            char *buf = NULL;
            char *dir;
                
            dir = strdup( nls_dir );
            if( dir && (buf= (char *)malloc(strlen(dir)+strlen(filename)+1+3+1)) ) {
                strcpy(stpcpy(stpcpy(stpcpy( buf, dir),"/"), filename),".mo");
                domain = load_domain( buf );                    
                free(buf);
            }
            free(dir);
        }
        if( !domain )
            return -1;
    }

    if( the_domain ) {
        free( the_domain->data );
        free( the_domain->mapped );
        free( the_domain );     
        the_domain = NULL;
    }
    the_domain = domain;
    return 0;
} /* set_gettext_file */


static const char*
get_string( struct loaded_domain *domain, u32 idx )
{
    char *p = domain->data + SWAPIT(domain->must_swap,
                                    domain->trans_tab[idx].offset);
    if( !domain->mapped[idx] ) {        
        domain->mapped[idx] = 1;                
    }
    return (const char*)p;
} /* get_string */

const char *
gettext( const char *msgid )
{
    struct loaded_domain *domain;
    size_t act = 0;
    size_t top, bottom;

    if( !(domain = the_domain) )        
        goto not_found;

    /* Locate the MSGID and its translation.  */
    if( domain->hash_size > 2 && domain->hash_tab ) {           
        /* Use the hashing table.  */           
        u32 len = strlen (msgid);       
        u32 hash_val = hash_string (msgid);     
        u32 idx = hash_val % domain->hash_size; 
        u32 incr = 1 + (hash_val % (domain->hash_size - 2));    
        u32 nstr = SWAPIT (domain->must_swap, domain->hash_tab[idx]);

        if ( !nstr ) /* Hash table entry is empty.  */  
            goto not_found;

                
        if( SWAPIT(domain->must_swap,   
            domain->orig_tab[nstr - 1].length) == len   
            && !strcmp( msgid,  
            domain->data + SWAPIT(domain->must_swap,
                                    domain->orig_tab[nstr - 1].offset)) )
                                    return get_string( domain, nstr - 1 );
        for(;;) {
            if (idx >= domain->hash_size - incr)
                idx -= domain->hash_size - incr;
            else
                idx += incr;
            nstr = SWAPIT(domain->must_swap, domain->hash_tab[idx]);
            if( !nstr ) 
                goto not_found; /* Hash table entry is empty.  */

            if ( SWAPIT(domain->must_swap,
                                domain->orig_tab[nstr - 1].length) == len
                                && !strcmp (msgid,
                                domain->data + SWAPIT(domain->must_swap,
                                           domain->orig_tab[nstr - 1].offset)))
                        
                                           return get_string( domain, nstr-1 );
        } /* NOTREACHED */
    }

    /* Now we try the default method:  binary search in the sorted
       array of messages.  */
    bottom = 0;
    top = domain->nstrings;
    while( bottom < top ) {             
        int cmp_val;
        
        act = (bottom + top) / 2;       
        cmp_val = strcmp(msgid, domain->data + SWAPIT(domain->must_swap,
                        domain->orig_tab[act].offset));
        if (cmp_val < 0)
            top = act;
        else if (cmp_val > 0)
            bottom = act + 1;
        else    
            return get_string( domain, act );
    }

not_found:
    return msgid;
} /* gettext */


/* XXX: this has to be placed in a .c file but not here */
#include <shlobj.h>

void _SHFree (void *p) 
{
    IMalloc *pm; 
    SHGetMalloc(&pm);
    if (pm) {
        pm->lpVtbl->Free(pm,p);
        pm->lpVtbl->Release(pm);
    } 
}
1	/* wptNLS.cpp - W32 Native Language Support
2	* Copyright (C) 2001, 2002, 2003 Timo Schulz
3	* Copyright (C) 1995-1999 Free Software Foundation, Inc.
4	*
5	* This code based on the simple-gettext.c code from the GnuPG
6	* by Ulrich Drepper.
7	*
8	* WinPT is free software; you can redistribute it and/or
9	* modify it under the terms of the GNU General Public License
10	* as published by the Free Software Foundation; either version 2
11	* of the License, or (at your option) any later version.
12	*
13	* WinPT is distributed in the hope that it will be useful,
14	* but WITHOUT ANY WARRANTY; without even the implied warranty of
15	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16	* General Public License for more details.
17	*
18	* You should have received a copy of the GNU General Public License
19	* along with WinPT; if not, write to the Free Software Foundation,
20	* Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21	*/
22	/* x-todo-status: OK */
23
24	#include <stdio.h>
25	#include <string.h>
26	#include <ctype.h>
27	#include <errno.h>
28	#include <sys/types.h>
29	#include <sys/stat.h>
30	#include <windows.h>
31
32	#include "wptTypes.h"
33	#include "wptNLS.h"
34
35
36	/* Missing W32 functions. */
37	static char *
38	stpcpy( char a,const char b )
39	{
40	while( *b )
41	a++ = b++;
42	*a = 0;
43	return (char*)a;
44	}
45
46	/* The magic number of the GNU message catalog format. */
47	#define MAGIC 0x950412de
48	#define MAGIC_SWAPPED 0xde120495
49
50	/* Revision number of the currently used .mo (binary) file format. */
51	#define MO_REVISION_NUMBER 0
52
53
54	/* Header for binary .mo file format. */
55	struct mo_file_header {
56	u32 magic; /* The magic number. */
57	u32 revision; /* The revision number of the file format. */
58	u32 nstrings; /* The number of strings pairs. */
59	u32 orig_tab_offset; /* Offset of table with start offsets of original
60	strings. */
61	u32 trans_tab_offset; /* Offset of table with start offsets of translation
62	strings. */
63	u32 hash_tab_size; /* Size of hashing table. */
64	u32 hash_tab_offset; /* Offset of first hashing entry. */
65	};
66
67	struct string_desc {
68	u32 length; /* Length of addressed string. */
69	u32 offset; /* Offset of string in file. */
70	};
71
72	struct loaded_domain {
73	char *data;
74	int must_swap;
75	u32 nstrings;
76	char *mapped;
77	struct string_desc *orig_tab;
78	struct string_desc *trans_tab;
79	u32 hash_size;
80	u32 *hash_tab;
81	};
82
83	static struct loaded_domain *the_domain;
84
85	static u32
86	do_swap_u32( u32 i )
87	{
88	return (i << 24) \| ((i & 0xff00) << 8) \| ((i >> 8) & 0xff00) \| (i >> 24);
89	}
90
91	#define SWAPIT(flag, data) ((flag) ? do_swap_u32(data) : (data) )
92
93
94	/* We assume to have `unsigned long int' value with at least 32 bits. */
95	#define HASHWORDBITS 32
96
97	/* The so called `hashpjw' function by P.J. Weinberger
98	[see Aho/Sethi/Ullman, COMPILERS: Principles, Techniques and Tools,
99	1986, 1987 Bell Telephone Laboratories, Inc.] */
100
101	static u32
102	hash_string( const char *str_param )
103	{
104	unsigned long int hval, g;
105	const char *str = str_param;
106
107	hval = 0;
108	while (*str != '\0') {
109	hval <<= 4;
110	hval += (unsigned long int) *str++;
111	g = hval & ((unsigned long int) 0xf << (HASHWORDBITS - 4));
112	if (g != 0) {
113	hval ^= g >> (HASHWORDBITS - 8);
114	hval ^= g;
115	}
116	}
117	return hval;
118	} /* hash_string */
119
120
121	static struct loaded_domain *
122	load_domain( const char *filename )
123	{
124	FILE *fp;
125	size_t size;
126	struct stat st;
127	struct mo_file_header *data = NULL;
128	struct loaded_domain *domain = NULL;
129	size_t to_read;
130	char *read_ptr;
131
132	fp = fopen( filename, "rb" );
133	if( !fp )
134	return NULL; /* can't open the file */
135	/* we must know about the size of the file */
136	if( fstat( fileno(fp ), &st )
137	\|\| (size = (size_t)st.st_size) != st.st_size
138	\|\| size < sizeof (struct mo_file_header) ) {
139	fclose( fp );
140	return NULL;
141	}
142
143	data = (struct mo_file_header *) malloc( size );
144	if( !data ) {
145	fclose( fp );
146	return NULL; /* out of memory */
147	}
148
149	to_read = size;
150	read_ptr = (char *) data;
151	do {
152	long int nb = fread( read_ptr, 1, to_read, fp );
153	if( nb < to_read ) {
154	fclose (fp);
155	free(data);
156	return NULL; /* read error */
157
158	}
159	read_ptr += nb;
160	to_read -= nb;
161	} while( to_read > 0 );
162	fclose (fp);
163
164	/* Using the magic number we can test whether it really is a message
165	* catalog file. */
166	if( data->magic != MAGIC && data->magic != MAGIC_SWAPPED ) {
167	/* The magic number is wrong: not a message catalog file. */
168	free( data );
169	return NULL;
170	}
171
172	domain = (struct loaded_domain )calloc( 1, sizeof domain );
173	if( !domain ) {
174	free( data );
175	return NULL;
176	}
177	domain->data = (char *) data;
178	domain->must_swap = data->magic != MAGIC;
179
180	/* Fill in the information about the available tables. */
181	switch( SWAPIT(domain->must_swap, data->revision) ) {
182	case 0:
183	domain->nstrings = SWAPIT(domain->must_swap, data->nstrings);
184	domain->orig_tab = (struct string_desc *)
185	((char *) data + SWAPIT(domain->must_swap, data->orig_tab_offset));
186	domain->trans_tab = (struct string_desc *)
187	((char *) data + SWAPIT(domain->must_swap, data->trans_tab_offset));
188	domain->hash_size = SWAPIT(domain->must_swap, data->hash_tab_size);
189	domain->hash_tab = (u32 *)
190	((char *) data + SWAPIT(domain->must_swap, data->hash_tab_offset));
191	break;
192
193	default: /* This is an invalid revision. */
194	free( data );
195	free( domain );
196	return NULL;
197	}
198
199	/* allocate an array to keep track of code page mappings */
200	domain->mapped = (char *)calloc( 1, domain->nstrings );
201	if( !domain->mapped ) {
202	free( data );
203	free( domain );
204	return NULL;
205	}
206
207	return domain;
208	} /* load_domain */
209
210
211	/****************
212	* Set the file used for translations. Pass a NULL to disable
213	* translation. A new filename may be set at anytime.
214	* WARNING: After changing the filename you shoudl not access any data
215	* retrieved by gettext().
216	*/
217	int
218	set_gettext_file( const char filename, const char nls_dir )
219	{
220	struct loaded_domain *domain = NULL;
221
222	if( filename && *filename ) {
223	if( filename[0] == '/'
224	\|\| ( isalpha(filename[0])
225	&& filename[1] == ':'
226	&& (filename[2] == '/' \|\| filename[2] == '\\') )
227	) {
228	/* absolute path - use it as is */
229	domain = load_domain( filename );
230	}
231	else { /* relative path - append ".mo" and get dir from the environment */
232	char *buf = NULL;
233	char *dir;
234
235	dir = strdup( nls_dir );
236	if( dir && (buf= (char *)malloc(strlen(dir)+strlen(filename)+1+3+1)) ) {
237	strcpy(stpcpy(stpcpy(stpcpy( buf, dir),"/"), filename),".mo");
238	domain = load_domain( buf );
239	free(buf);
240	}
241	free(dir);
242	}
243	if( !domain )
244	return -1;
245	}
246
247	if( the_domain ) {
248	free( the_domain->data );
249	free( the_domain->mapped );
250	free( the_domain );
251	the_domain = NULL;
252	}
253	the_domain = domain;
254	return 0;
255	} /* set_gettext_file */
256
257
258	static const char*
259	get_string( struct loaded_domain *domain, u32 idx )
260	{
261	char *p = domain->data + SWAPIT(domain->must_swap,
262	domain->trans_tab[idx].offset);
263	if( !domain->mapped[idx] ) {
264	domain->mapped[idx] = 1;
265	}
266	return (const char*)p;
267	} /* get_string */
268
269	const char *
270	gettext( const char *msgid )
271	{
272	struct loaded_domain *domain;
273	size_t act = 0;
274	size_t top, bottom;
275
276	if( !(domain = the_domain) )
277	goto not_found;
278
279	/* Locate the MSGID and its translation. */
280	if( domain->hash_size > 2 && domain->hash_tab ) {
281	/* Use the hashing table. */
282	u32 len = strlen (msgid);
283	u32 hash_val = hash_string (msgid);
284	u32 idx = hash_val % domain->hash_size;
285	u32 incr = 1 + (hash_val % (domain->hash_size - 2));
286	u32 nstr = SWAPIT (domain->must_swap, domain->hash_tab[idx]);
287
288	if ( !nstr ) /* Hash table entry is empty. */
289	goto not_found;
290
291
292	if( SWAPIT(domain->must_swap,
293	domain->orig_tab[nstr - 1].length) == len
294	&& !strcmp( msgid,
295	domain->data + SWAPIT(domain->must_swap,
296	domain->orig_tab[nstr - 1].offset)) )
297	return get_string( domain, nstr - 1 );
298	for(;;) {
299	if (idx >= domain->hash_size - incr)
300	idx -= domain->hash_size - incr;
301	else
302	idx += incr;
303	nstr = SWAPIT(domain->must_swap, domain->hash_tab[idx]);
304	if( !nstr )
305	goto not_found; /* Hash table entry is empty. */
306
307	if ( SWAPIT(domain->must_swap,
308	domain->orig_tab[nstr - 1].length) == len
309	&& !strcmp (msgid,
310	domain->data + SWAPIT(domain->must_swap,
311	domain->orig_tab[nstr - 1].offset)))
312
313	return get_string( domain, nstr-1 );
314	} /* NOTREACHED */
315	}
316
317	/* Now we try the default method: binary search in the sorted
318	array of messages. */
319	bottom = 0;
320	top = domain->nstrings;
321	while( bottom < top ) {
322	int cmp_val;
323
324	act = (bottom + top) / 2;
325	cmp_val = strcmp(msgid, domain->data + SWAPIT(domain->must_swap,
326	domain->orig_tab[act].offset));
327	if (cmp_val < 0)
328	top = act;
329	else if (cmp_val > 0)
330	bottom = act + 1;
331	else
332	return get_string( domain, act );
333	}
334
335	not_found:
336	return msgid;
337	} /* gettext */
338
339
340	/* XXX: this has to be placed in a .c file but not here */
341	#include <shlobj.h>
342
343	void _SHFree (void *p)
344	{
345	IMalloc *pm;
346	SHGetMalloc(&pm);
347	if (pm) {
348	pm->lpVtbl->Free(pm,p);
349	pm->lpVtbl->Release(pm);
350	}
351	}