config_buf_ungetc: warn when pushing back a random character
commit1d0655c15ebf7dfb460466d058daab790ed285b2
authorJeff King <peff@peff.net>
Thu, 5 Feb 2015 21:00:24 +0000 (5 16:00 -0500)
committerJunio C Hamano <gitster@pobox.com>
Thu, 5 Feb 2015 21:16:55 +0000 (5 13:16 -0800)
treef3468288bbf3c6339022cac78a94c4d819d11661
parent5e0be134d35a31f41921f89331a95337bb38c152
config_buf_ungetc: warn when pushing back a random character

Our config code simulates a stdio stream around a buffer,
but our fake ungetc() does not behave quite like the real
one. In particular, we only rewind the position by one
character, but do _not_ actually put the character from the
caller into position.

It turns out that this does not matter, because we only ever
push back the character we just read. In other words, such
an assignment would be a noop. But because the function is
called ungetc, and because it takes a character parameter,
it is a mistake waiting to happen.

Actually assigning the character into the buffer would be
ideal, but our pointer is actually a "const" copy of the
buffer. We do not know who the real owner of the buffer is
in this code, and would not want to munge their contents.

Instead, we can simply add an assertion that matches what
the current caller does, and will let us know if new callers
are added that violate the contract.

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
config.c