Skip to content

Rename bgets function to bgetstream #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Rename bgets function to bgetstream #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion bsafe.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ char * strcat (char *dst, const char *src) {
#if !defined (__GNUC__) && (!defined(_MSC_VER) || (_MSC_VER <= 1310))
char * (gets) (char * buf) {
(void) buf;
fprintf (stderr, "bsafe error: gets() is not safe, use bgets.\n");
fprintf (stderr, "bsafe error: gets() is not safe, use bgetstream.\n");
if (bsafeShouldExit) exit (-1);
return NULL;
}
Expand Down
14 changes: 7 additions & 7 deletions bstest.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3115,15 +3115,15 @@ struct emuFile f;
bstring b0, b1, b2, b3;
int ret = 0;

printf ("TEST: bgets/breads test\n");
printf ("TEST: bgetstream/breads test\n");

test38_aux_bNopen (&f, &shortBstring);

/* Creation/reads */

b0 = bgets ((bNgetc) test38_aux_bNgetc, &f, (char) 'b');
b0 = bgetstream ((bNgetc) test38_aux_bNgetc, &f, (char) 'b');
b1 = bread ((bNread) test38_aux_bNread, &f);
b2 = bgets ((bNgetc) test38_aux_bNgetc, &f, (char) '\0');
b2 = bgetstream ((bNgetc) test38_aux_bNgetc, &f, (char) '\0');
b3 = bread ((bNread) test38_aux_bNread, &f);

ret += 1 != biseqcstr (b0, "b");
Expand All @@ -3135,22 +3135,22 @@ int ret = 0;

f.ofs = 0;

ret += 0 <= bgetsa (NULL, (bNgetc) test38_aux_bNgetc, &f, (char) 'o');
ret += 0 <= bgetstreama (NULL, (bNgetc) test38_aux_bNgetc, &f, (char) 'o');
ret += 0 <= breada (NULL, (bNread) test38_aux_bNread, &f);
ret += 0 <= bgetsa (&shortBstring, (bNgetc) test38_aux_bNgetc, &f, (char) 'o');
ret += 0 <= bgetstreama (&shortBstring, (bNgetc) test38_aux_bNgetc, &f, (char) 'o');
ret += 0 <= breada (&shortBstring, (bNread) test38_aux_bNread, &f);

/* Normal accumulations */

ret += 0 > bgetsa (b0, (bNgetc) test38_aux_bNgetc, &f, (char) 'o');
ret += 0 > bgetstreama (b0, (bNgetc) test38_aux_bNgetc, &f, (char) 'o');
ret += 0 > breada (b1, (bNread) test38_aux_bNread, &f);

ret += 1 != biseqcstr (b0, "bbo");
ret += 1 != biseqcstr (b1, "ogusgus");

/* Attempt to append past end should do nothing */

ret += 0 > bgetsa (b0, (bNgetc) test38_aux_bNgetc, &f, (char) 'o');
ret += 0 > bgetstreama (b0, (bNgetc) test38_aux_bNgetc, &f, (char) 'o');
ret += 0 > breada (b1, (bNread) test38_aux_bNread, &f);

ret += 1 != biseqcstr (b0, "bbo");
Expand Down
10 changes: 5 additions & 5 deletions bstrlib.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1964,7 +1964,7 @@ int c, d, e;
return d == 0 && c < 0;
}

/* int bgetsa (bstring b, bNgetc getcPtr, void * parm, char terminator)
/* int bgetstreama (bstring b, bNgetc getcPtr, void * parm, char terminator)
*
* Use an fgetc-like single character stream reading function (getcPtr) to
* obtain a sequence of characters which are concatenated to the end of the
Expand All @@ -1977,7 +1977,7 @@ int c, d, e;
* an empty partial result, 1 is returned. If no characters are read, or
* there is some other detectable error, BSTR_ERR is returned.
*/
int bgetsa (bstring b, bNgetc getcPtr, void * parm, char terminator) {
int bgetstreama (bstring b, bNgetc getcPtr, void * parm, char terminator) {
int c, d, e;

if (b == NULL || b->mlen <= 0 || b->slen < 0 || b->mlen < b->slen ||
Expand All @@ -2002,7 +2002,7 @@ int c, d, e;
return d == 0 && c < 0;
}

/* bstring bgets (bNgetc getcPtr, void * parm, char terminator)
/* bstring bgetstream (bNgetc getcPtr, void * parm, char terminator)
*
* Use an fgetc-like single character stream reading function (getcPtr) to
* obtain a sequence of characters which are concatenated into a bstring.
Expand All @@ -2013,10 +2013,10 @@ int c, d, e;
* result obtained thus far is returned. If no characters are read, or
* there is some other detectable error, NULL is returned.
*/
bstring bgets (bNgetc getcPtr, void * parm, char terminator) {
bstring bgetstream (bNgetc getcPtr, void * parm, char terminator) {
bstring buff;

if (0 > bgetsa (buff = bfromcstr (""), getcPtr, parm, terminator) ||
if (0 > bgetstreama (buff = bfromcstr (""), getcPtr, parm, terminator) ||
0 >= buff->slen) {
bdestroy (buff);
buff = NULL;
Expand Down
4 changes: 2 additions & 2 deletions bstrlib.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,9 +170,9 @@ typedef int (*bNgetc) (void *parm);
typedef size_t (* bNread) (void *buff, size_t elsize, size_t nelem, void *parm);

/* Input functions */
extern bstring bgets (bNgetc getcPtr, void * parm, char terminator);
extern bstring bgetstream (bNgetc getcPtr, void * parm, char terminator);
extern bstring bread (bNread readPtr, void * parm);
extern int bgetsa (bstring b, bNgetc getcPtr, void * parm, char terminator);
extern int bgetstreama (bstring b, bNgetc getcPtr, void * parm, char terminator);
extern int bassigngets (bstring b, bNgetc getcPtr, void * parm, char terminator);
extern int breada (bstring b, bNread readPtr, void * parm);

Expand Down
28 changes: 14 additions & 14 deletions bstrlib.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,7 @@ assured by the bstring library itself.
bStreams
--------

In addition to the bgets and bread functions, bstrlib can abstract streams
In addition to the bgetstream and bread functions, bstrlib can abstract streams
with a high performance read only stream called a bStream. In general, the
idea is to open a core stream (with something like fopen) then pass its
handle as well as a bNread function pointer (like fread) to the bsopen
Expand All @@ -209,21 +209,21 @@ Finally, the bsclose function is called to close the bStream -- it will
return a handle to the original (core) stream. So bStreams, essentially,
wrap other streams.

The bStreams have two main advantages over the bgets and bread (as well as
The bStreams have two main advantages over the bgetstream and bread (as well as
fgets/ungetc) paradigms:

1) Improved functionality via the bunread function which allows a stream to
unread characters, giving the bStream stack-like functionality if so
desired.
2) A very high performance bsreadln function. The C library function fgets()
(and the bgets function) can typically be written as a loop on top of
(and the bgetstream function) can typically be written as a loop on top of
fgetc(), thus paying all of the overhead costs of calling fgetc on a per
character basis. bsreadln will read blocks at a time, thus amortizing the
overhead of fread calls over many characters at once.

However, clearly bStreams are suboptimal or unusable for certain kinds of
streams (stdin) or certain usage patterns (a few spotty, or non-sequential
reads from a slow stream.) For those situations, using bgets will be more
reads from a slow stream.) For those situations, using bgetstream will be more
appropriate.

The semantics of bStreams allows practical construction of layerable data
Expand Down Expand Up @@ -1612,7 +1612,7 @@ The functions

..........................................................................

extern bstring bgets (bNgetc getcPtr, void * parm, char terminator);
extern bstring bgetstream (bNgetc getcPtr, void * parm, char terminator);
typedef int (* bNgetc) (void * parm);

Read a bstring from a stream. As many bytes as is necessary are read
Expand All @@ -1627,7 +1627,7 @@ The functions
parameter of fgets.) If no characters are read, or there is some other
detectable error, NULL is returned.

bgets will never call the getcPtr function more often than necessary to
bgetstream will never call the getcPtr function more often than necessary to
construct its output (including a single call, if required, to determine
that the stream contains no more characters.)

Expand All @@ -1639,17 +1639,17 @@ The functions
For files, this function can be used analogously as fgets as follows:

fp = fopen ( ... );
if (fp) b = bgets ((bNgetc) fgetc, fp, '\n');
if (fp) b = bgetstream ((bNgetc) fgetc, fp, '\n');

(Note that only one terminator character can be used, and that '\0' is
not assumed to terminate the stream in addition to the terminator
character. This is consistent with the semantics of fgets.)

..........................................................................

extern int bgetsa (bstring b, bNgetc getcPtr, void * parm, char terminator);
extern int bgetstreama (bstring b, bNgetc getcPtr, void * parm, char terminator);

Read from a stream and concatenate to a bstring. Behaves like bgets,
Read from a stream and concatenate to a bstring. Behaves like bgetstream,
except that it appends it results to the bstring b. The value 1 is
returned if no characters are read before a negative result is returned
from getcPtr. Otherwise BSTR_ERR is returned on error, and 0 is returned
Expand All @@ -1659,7 +1659,7 @@ The functions

extern int bassigngets (bstring b, bNgetc getcPtr, void * parm, char terminator);

Read from a stream and concatenate to a bstring. Behaves like bgets,
Read from a stream and concatenate to a bstring. Behaves like bgetstream,
except that it assigns the results to the bstring b. The value 1 is
returned if no characters are read before a negative result is returned
from getcPtr. Otherwise BSTR_ERR is returned on error, and 0 is returned
Expand Down Expand Up @@ -1701,7 +1701,7 @@ The functions
read, BSTR_ERR is returned. This function may read additional characters
into the stream buffer from the core stream that are not returned, but
will be retained for subsequent read operations. When reading from high
speed streams, this function can perform significantly faster than bgets.
speed streams, this function can perform significantly faster than bgetstream.

..........................................................................

Expand All @@ -1714,7 +1714,7 @@ The functions
read, BSTR_ERR is returned. This function may read additional characters
into the stream buffer from the core stream that are not returned, but
will be retained for subsequent read operations. When reading from high
speed streams, this function can perform significantly faster than bgets.
speed streams, this function can perform significantly faster than bgetstream.

..........................................................................

Expand Down Expand Up @@ -2331,7 +2331,7 @@ functions and CBString methods that should be used instead of them.

C-library Bstring alternative CBString alternative
--------- ------------------- --------------------
gets bgets ::gets
gets bgetstream ::gets
strcpy bassign = operator
strncpy bassignmidstr ::midstr
strcat bconcat += operator
Expand Down Expand Up @@ -2630,7 +2630,7 @@ effective mechanisms at ferreting out bugs.)
Function pointers:
..................

The bgets, bread and bStream functions use function pointers to obtain
The bgetstream, bread and bStream functions use function pointers to obtain
strings from data streams. The function pointer declarations have been
specifically chosen to be compatible with the fgetc and fread functions.
While this may seem to be a convoluted way of implementing fgets and fread
Expand Down
2 changes: 1 addition & 1 deletion bstrwrap.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1179,7 +1179,7 @@ void CBString::repeat (int count) {

int CBString::gets (bNgetc getcPtr, void * parm, char terminator) {
if (mlen <= 0) bstringThrow ("Write protection error");
bstring b = bgets (getcPtr, parm, terminator);
bstring b = bgetstream (getcPtr, parm, terminator);
if (b == NULL) {
slen = 0;
return -1;
Expand Down