]> pd.if.org Git - pdclib.old/blob - functions/stdio/ftell.c
win32: initial pass at thread support
[pdclib.old] / functions / stdio / ftell.c
1 /* $Id$ */
2
3 /* ftell( FILE * )
4
5    This file is part of the Public Domain C Library (PDCLib).
6    Permission is granted to use, modify, and / or redistribute at will.
7 */
8
9 #include <stdio.h>
10 #include <limits.h>
11
12 #ifndef REGTEST
13
14 long int ftell( struct _PDCLIB_file_t * stream )
15 {
16     /* ftell() must take into account:
17        - the actual *physical* offset of the file, i.e. the offset as recognized
18          by the operating system (and stored in stream->pos.offset); and
19        - any buffers held by PDCLib, which
20          - in case of unwritten buffers, count in *addition* to the offset; or
21          - in case of unprocessed pre-read buffers, count in *substraction* to
22            the offset. (Remember to count ungetidx into this number.)
23        Conveniently, the calculation ( ( bufend - bufidx ) + ungetidx ) results
24        in just the right number in both cases:
25          - in case of unwritten buffers, ( ( 0 - unwritten ) + 0 )
26            i.e. unwritten bytes as negative number
27          - in case of unprocessed pre-read, ( ( preread - processed ) + unget )
28            i.e. unprocessed bytes as positive number.
29        That is how the somewhat obscure return-value calculation works.
30     */
31     /*  If offset is too large for return type, report error instead of wrong
32         offset value.
33     */
34     /* TODO: Check what happens when ungetc() is called on a stream at offset 0 */
35     if ( ( stream->pos.offset - stream->bufend ) > ( LONG_MAX - ( stream->bufidx - stream->ungetidx ) ) )
36     {
37         /* integer overflow */
38         _PDCLIB_errno = _PDCLIB_ERANGE;
39         return -1;
40     }
41     long int res = ( stream->pos.offset - ( ( (int)stream->bufend - (int)stream->bufidx ) + stream->ungetidx ) );
42     return res;
43 }
44
45 #endif
46
47 #ifdef TEST
48 #include <_PDCLIB_test.h>
49
50 #include <stdlib.h>
51
52 int main( void )
53 {
54     /* Testing all the basic I/O functions individually would result in lots
55        of duplicated code, so I took the liberty of lumping it all together
56        here.
57     */
58     /* The following functions delegate their tests to here:
59        fgetc fflush rewind fputc ungetc fseek
60        flushbuffer seek fillbuffer prepread prepwrite
61     */
62     char * buffer = (char*)malloc( 4 );
63     FILE * fh;
64     TESTCASE( ( fh = tmpfile() ) != NULL );
65     TESTCASE( setvbuf( fh, buffer, _IOLBF, 4 ) == 0 );
66     /* Testing ungetc() at offset 0 */
67     rewind( fh );
68     TESTCASE( ungetc( 'x', fh ) == 'x' );
69     TESTCASE( ftell( fh ) == -1l );
70     rewind( fh );
71     TESTCASE( ftell( fh ) == 0l );
72     /* Commence "normal" tests */
73     TESTCASE( fputc( '1', fh ) == '1' );
74     TESTCASE( fputc( '2', fh ) == '2' );
75     TESTCASE( fputc( '3', fh ) == '3' );
76     /* Positions incrementing as expected? */
77     TESTCASE( ftell( fh ) == 3l );
78     TESTCASE_NOREG( fh->pos.offset == 0l );
79     TESTCASE_NOREG( fh->bufidx == 3l );
80     /* Buffer properly flushed when full? */
81     TESTCASE( fputc( '4', fh ) == '4' );
82     TESTCASE_NOREG( fh->pos.offset == 4l );
83     TESTCASE_NOREG( fh->bufidx == 0 );
84     /* fflush() resetting positions as expected? */
85     TESTCASE( fputc( '5', fh ) == '5' );
86     TESTCASE( fflush( fh ) == 0 );
87     TESTCASE( ftell( fh ) == 5l );
88     TESTCASE_NOREG( fh->pos.offset == 5l );
89     TESTCASE_NOREG( fh->bufidx == 0l );
90     /* rewind() resetting positions as expected? */
91     rewind( fh );
92     TESTCASE( ftell( fh ) == 0l );
93     TESTCASE_NOREG( fh->pos.offset == 0 );
94     TESTCASE_NOREG( fh->bufidx == 0 );
95     /* Reading back first character after rewind for basic read check */
96     TESTCASE( fgetc( fh ) == '1' );
97     /* TODO: t.b.c. */
98     TESTCASE( fclose( fh ) == 0 );
99     return TEST_RESULTS;
100 }
101
102 #endif
103