sys-file-reader: Refactor to clean up character encoding support.

The system file format is unusual in that it does not record the encoding
used by character strings at the beginning or at any fixed place in the
file.  Instead, it can be recorded practically anywhere in the file.  It
never precedes all of the actual character strings in the file, which makes
it impossible to interpret those strings completely and correctly until it
is encountered.

Until now, the system file reader has dealt with this situation by
stuffing uninterpreted character strings into data structures until the
encoding is known, then at that point fetching out the character strings,
reencoding them, and stuffing them back into the data structures.  This
does work, but it has the disadvantage that all of the PSPP data
structures have to tolerate character strings with unknown encoding.  In
some cases this seems like an ugly situation.  For example, arbitrary
variable names have to be supported, even though the syntax for variable
names is circumscribed by the language, because the syntax rules for
variable names cannot be completely and correctly applied to a string that
is in an unknown encoding.

This commit fixes that problem by adopting a new way to read system files.
Each record in the system file dictionary is essentially slurped into
memory as a chunk, then the character encoding is extracted from it, then
the rest of the dictionary is interpreted based on that encoding.  The
actual implementation is a little more intricate because the format of
system file records is somewhat non-uniform.

file-name: Do not make output files line-buffered in fn_open().

I don't see any reason to do this.  I can't see anything in the commit
log for this file or in OChangeLog that explains why it was done.

data-reader: Remove unreachable "return" statements.

file-handle-def: Use hmap instead of list for name table.

It makes much more sense to keep an index of names using a hash table
than using a linked list.

Update all #include directives to the currently preferred style.

I left src/ui/gui alone for now.

Smake: Remove ulc-width-linebreaks module.

This function has not been used in PSPP for a long time now.

FREQUENCIES: Fix percentiles calculation.

The condition for using a variate directly instead of interpolating was
just wrong.  It would interpolate in cases where it clearly should not,
which produced incorrect results in many cases.

Thanks to Fabio Bordignon <bordignon@demos.it> for reporting the problem
and supplying a simple test case.

T-TEST: Fix use-after-free with TEMPORARY and independent samples.

When TEMPORARY is in effect, proc_commit() destroys the temporary
dictionary.  This means that any procedure that does not somehow disable
temporary transformations and refers to a variable following proc_commit()
has a use-after-free error.

T-TEST has two different bugs of this type.  First, the loop that destroys
group statistics refers to destroyed variables.  This commit fixes this
problem by instead using variable aux data destructors to destroy group
statistics.

Second, when there is an independent variable, destroying its values
requires knowing the variable's width.  This commit fixes this problem by
destroying the values before calling proc_commit().

The AUTORECODE, DESCRIPTIVES, RANK, and REGRESSION procedures appear to
have similar issues (not fixed by this commit).

Reported by Jeremy Lavergne <jeremy@lavergne.gotdns.org>.

group: Delete unused functions.

DELETE VARIABLES: Style fix.

README.Git: Update to newer commit.

This is the Gnulib commit I'm testing against locally.  It should fix the
problem that showed up in the nightly build, in which the dtoastr module
was missing.

data-out: Add test for non-ASCII custom currency formats.

These now work as I would expect, so add a test to avoid future regression.

data-out: Optimize and fix some bad assumptions.

Until now, data_out_pool() and its wrapper function data_out() have always
done at least two memory allocations: one to fill in the initial version
of the result and another to recode it to UTF-8.  However, recoding to
UTF-8 is usually unnecessary, because most output formats always produce
output in UTF-8 anyway.  Only binary formats and the string A format ever
produce data in other encodings, so this commit drops recoding entirely
except for those cases.  Binary formats are a particularly special case:
usually it doesn't make any sense to use these formats for text output,
but this commit does its best to translate the binary output bytes into
valid UTF-8, at least up to the first null byte.

This commit also finishes fixing up display widths.

The closely related data_out_legacy() function, which only has one user
in three also needed some work.  It was badly named, so I renamed it to
data_out_recode().  It made the bad assumption that the data passed in
was encoded in ASCII (written C_ENCODING).  It also made the bad
assumption that the number of bytes output would be exactly the format's
width.  This rewrite fixes these problems.

pool: Support NULL pool argument to pool_alloc_unaligned().

I don't see a reason that this should be unsupported.

data-out: Reorganize output_Z() to be more easily understood.

It took me a minute to figure out what was going on here, so this commit
slightly reorganizes it.

format: Count prefix and suffix width in terms of display columns.

Until now, the prefixes and suffixes for custom currency formats
(CCA, etc.) have been considered to occupy one display column per
byte.  This is fine for prefixes and suffixes like "$" or "%", but
falls down badly with U+00A5 (¥) or U+20AC (€), which occupy two
or three bytes, respectively, in UTF-8, while occupying only a
single display column.

This commit fixes the problem.  It doesn't add a test yet because
there are still some higher-level issues, but that will come in
a later commit when those remaining issues are resolved.

format: Create a new "struct fmt_affix" for prefix and suffix strings.

This combines two changes: changing the string type for numeric
prefix and suffix strings from "struct substring" to plain "char *",
and putting the string inside a new structure.  Both of these will
make more sense after the following commit, which adds another member
to the new structure and stops using the length of the string in so
many places (which is the reason that "struct substring" was a good
choice).

data-out: Make each converter responsible for storing null terminator.

Until now, every converter has produced output that is exactly as many
bytes long as the format's width.  In upcoming patches this will change,
because in UTF-8 a character that occupies a single display column can
require multiple bytes.  In preparation, this commit requires the
individual converters to write out their own null byte, giving a bit
more flexibility regarding length.

format: Increase abstraction of fmt_number_style.

Upcoming commits will make some changes to fmt_number_style, so it
seems best to avoid having clients actually construct and modify
instances of this structure.  This commit makes that change.

We could take it one step further and add accessor functions even
for reading out the structure, but in my opinion that would be
overkill for this structure.

legacy-encoding: Remove.

The functions in this module are no longer used.

i18n: Introduce C_ENCODING as replacement for LEGACY_NATIVE.

The LEGACY_NATIVE name seems a bit awkward for something that is just the
name of the encoding for strings in C source code, that is, the C locale,
so this commit renames it to C_ENCODING and moves it to i18n.h with the
rest of the encoding-related functions.

In addition, PSPP assumes in various places that the local system has
ASCII-based locales.  I don't think there's much point in pretending to
support EBCDIC, so this commit removes that little bit of support.

i18n: New function recode_byte().

PRINT: Use UTF-8 encoding for output to the output subsystem.

All string data coming into the output subsystem must be encoded in UTF-8,
but PRINT was recoding it into ASCII instead.

CROSSTABS: Eliminate redundant data copying.

There's no point in copying the output string twice.

Use new Gnulib function dtoastr() to format short, accurate real numbers.

%.*g with DBL_DIG + 1 as argument is simple but in rare cases it fails to
accurately format a real number.  The recently added Gnulib routine
dtoastr() always formats a real number accurately, so switch to using it
for these cases.

operations.def: Fix indentation.

PRINT SPACE: When an output file is specified, don't ignore expression.

When both OUTFILE= and an expression were specified on PRINT SPACE, the
expression was ignored (if it was only a single token) or an error would
occur (if it was was more than one token).

GET DATA: Get rid of lex_put_back().

An upcoming commit will get rid of lex_put_back(), so don't use it here.

float-format: Eliminate tests' dependence on exact string encoding.

Until now, the float-format tests have depended on the PSPP syntax
accepting arbitrary byte values in strings, without treating them as part
of any particular encoding.  The lexer is being rewritten so that this
assumption is no longer true, so this commit eliminates this assumption in
the float-format tests.  After this commit, the tests only use ASCII
characters in strings.

por-file-reader: Remove dependency on VAR_NAME_LEN.

VAR_NAME_LEN wasn't really needed here because we knew that the name we
started from was no more than 8 bytes long.  Also, we know that we can
come up with a unique name within ULONG_MAX tries since we'd run out of
memory before running out of values to try.

Most uses of VAR_NAME_LEN within PSPP are wrong due to encoding issues:
the limit applies to variable names in the encoding used by the data
set, but most uses of VAR_NAME_LEN actually limit the length of a name
in UTF-8.  The UTF-8 representation of a name can be longer or shorter
than its representation in the data set encoding, so it seems best to
eliminate references to VAR_NAME_LEN entirely.

text-data-import-dialog: Eliminate VAR_NAME_LEN restriction.

Most uses of VAR_NAME_LEN within PSPP are wrong due to encoding issues:
the limit applies to variable names in the encoding used by the data
set, but most uses of VAR_NAME_LEN actually limit the length of a name
in UTF-8.  The UTF-8 representation of a name can be longer or shorter
than its representation in the data set encoding, so it seems best to
eliminate references to VAR_NAME_LEN entirely.

REGRESSION: Eliminate restriction to VAR_NAME_LEN in reg_get_name().

There's still an obvious problem here that the prefix isn't being trimmed
down so that the suffix will fit.  Since an upcoming series of changes
would have to completely redo how this would be done, I'm not fixing that
now, only marking it with XXX.

Most uses of VAR_NAME_LEN within PSPP are wrong due to encoding issues:
the limit applies to variable names in the encoding used by the data
set, but most uses of VAR_NAME_LEN actually limit the length of a name
in UTF-8.  The UTF-8 representation of a name can be longer or shorter
than its representation in the data set encoding, so it seems best to
eliminate references to VAR_NAME_LEN entirely.

FLIP: Eliminate false dependency on VAR_NAME_LEN.

The size of this buffer really shouldn't have anything to do with
VAR_NAME_LEN but with the string about to be put into it.

Most uses of VAR_NAME_LEN within PSPP are wrong due to encoding issues:
the limit applies to variable names in the encoding used by the data
set, but most uses of VAR_NAME_LEN actually limit the length of a name
in UTF-8.  The UTF-8 representation of a name can be longer or shorter
than its representation in the data set encoding, so it seems best to
eliminate references to VAR_NAME_LEN entirely.

DESCRIPTIVES: Eliminate main restriction on Z-score variable name length.

variable-parser: Drop VAR_NAME_LEN restriction from var_set_lookup_var_idx().

This restriction is purely artificial, as part of an assertion.  Since
longer variable names are going to have to be supported, remove it.

Most uses of VAR_NAME_LEN within PSPP are wrong due to encoding issues:
the limit applies to variable names in the encoding used by the data
set, but most uses of VAR_NAME_LEN actually limit the length of a name
in UTF-8.  The UTF-8 representation of a name can be longer or shorter
than its representation in the data set encoding, so it seems best to
eliminate references to VAR_NAME_LEN entirely.

variable-parser: Rewrite parse_DATA_LIST_vars().

This rewrite was prompted by getting rid of the VAR_NAME_LEN limit inside
parse_DATA_LIST_vars(), but then I noticed that the variable naming and
coding style was dated, and that duplicate variable names were only
detected for variables named using TO, not for individual names, so I
rewrote much of the code instead.

DEBUG EVALUATE: Eliminate VAR_NAME_LEN limit.

Most uses of VAR_NAME_LEN within PSPP are wrong due to encoding issues:
the limit applies to variable names in the encoding used by the data
set, but most uses of VAR_NAME_LEN actually limit the length of a name
in UTF-8.  The UTF-8 representation of a name can be longer or shorter
than its representation in the data set encoding, so it seems best to
eliminate references to VAR_NAME_LEN entirely.

VECTOR: Eliminate VAR_NAME_LEN limit for variable names.

Most uses of VAR_NAME_LEN within PSPP are wrong due to encoding issues:
the limit applies to variable names in the encoding used by the data
set, but most uses of VAR_NAME_LEN actually limit the length of a name
in UTF-8.  The UTF-8 representation of a name can be longer or shorter
than its representation in the data set encoding, so it seems best to
eliminate references to VAR_NAME_LEN entirely.

MODIFY VARIABLES: Eliminate VAR_NAME_LEN limit on variable names.

This is actually a general code improvement, since it eliminates memory
allocation and copying that was not actually necessary.

Most uses of VAR_NAME_LEN within PSPP are wrong due to encoding issues:
the limit applies to variable names in the encoding used by the data
set, but most uses of VAR_NAME_LEN actually limit the length of a name
in UTF-8.  The UTF-8 representation of a name can be longer or shorter
than its representation in the data set encoding, so it seems best to
eliminate references to VAR_NAME_LEN entirely.

DATAFILE ATTRIBUTE, VARIABLE ATTRIBUTE: Eliminate VAR_NAME_LEN limit.

Most uses of VAR_NAME_LEN within PSPP are wrong due to encoding issues:
the limit applies to variable names in the encoding used by the data
set, but most uses of VAR_NAME_LEN actually limit the length of a name
in UTF-8.  The UTF-8 representation of a name can be longer or shorter
than its representation in the data set encoding, so it seems best to
eliminate references to VAR_NAME_LEN entirely.

GET DATA /TYPE=TXT: Get rid of VAR_NAME_LEN limit on variable names.

Most uses of VAR_NAME_LEN within PSPP are wrong due to encoding issues:
the limit applies to variable names in the encoding used by the data
set, but most uses of VAR_NAME_LEN actually limit the length of a name
in UTF-8.  The UTF-8 representation of a name can be longer or shorter
than its representation in the data set encoding, so it seems best to
eliminate references to VAR_NAME_LEN entirely.

FILE HANDLE: Get rid of VAR_NAME_LEN limit on handle name.

Most uses of VAR_NAME_LEN within PSPP are wrong due to encoding issues:
the limit applies to variable names in the encoding used by the data
set, but most uses of VAR_NAME_LEN actually limit the length of a name
in UTF-8.  The UTF-8 representation of a name can be longer or shorter
than its representation in the data set encoding, so it seems best to
eliminate references to VAR_NAME_LEN entirely.

combine-files: Eliminate VAR_NAME_LEN restriction from combine_files().

Most uses of VAR_NAME_LEN within PSPP are wrong due to encoding issues:
the limit applies to variable names in the encoding used by the data
set, but most uses of VAR_NAME_LEN actually limit the length of a name
in UTF-8.  The UTF-8 representation of a name can be longer or shorter
than its representation in the data set encoding, so it seems best to
eliminate references to VAR_NAME_LEN entirely.

vector: Remove VAR_NAME_LEN limit for internal representation of name.

Most uses of VAR_NAME_LEN within PSPP are wrong due to encoding issues:
the limit applies to variable names in the encoding used by the data
set, but most uses of VAR_NAME_LEN actually limit the length of a name
in UTF-8.  The UTF-8 representation of a name can be longer or shorter
than its representation in the data set encoding, so it seems best to
eliminate references to VAR_NAME_LEN entirely.

variable: Remove VAR_NAME_LEN limit for internal representation of name.

Most uses of VAR_NAME_LEN within PSPP are wrong due to encoding issues:
the limit applies to variable names in the encoding used by the data
set, but most uses of VAR_NAME_LEN actually limit the length of a name
in UTF-8.  The UTF-8 representation of a name can be longer or shorter
than its representation in the data set encoding, so it seems best to
eliminate references to VAR_NAME_LEN entirely.

dict: Make dict_make_unique_var_name() return an allocated string.

tests: Add `check-programs' target.

Occasionally I want to build all the programs required to run "make check"
without actually running the tests.  This target allows me to do that.

Smake: Avoid duplicating $(GNULIB_TOOL) invocation.

The "all" and "gnulib" rules both contained the same gnulib-tool
invocation.  This commit changes the "all" rule to use the "gnulib" rule
as a subrule.

i18n: Always allocate from pool in recode_substring_pool().

sys-file-writer: Fix subtype used for v14+ multiple response set records.

doc: Document that type-7 records must appear in ascending numerical order.

Every system file that I have seen puts them in this order, so I cannot
imagine that any other order receives any testing.

doc: Update description of character encoding information in system files.

Based on information provided by John Darrington and on system files
obtained freely from the Internet.

sys-file-reader: Add tests.

sys-file-reader: Elevate invalid number of labels from warning to error.

There's no way to figure out when the labels end when the count is wrong,
so this has to be an error.

sys-file-reader: Avoid redundant "within system file" in messages.

All system file message already state the system file's name, which should
be enough identification.

sys-file-reader: Improve debugging usefulness of error messages.

I found that these changes made it easier to debug problems with system
files while I was developing tests.

sys-file-reader: Really enable warnings for invalid variable formats.

With these operator in the wrong order, I never saw any warnings, although
other people might have seen different behavior.

sys-file-reader: Add missing periods at end of error messages.

Most of the error messages already ended in periods, so this adds them to
the others for consistency.

sys-file-reader: Check that multiple response set names begin with `$'.

This invariant was being checked by an assertion in dict_add_mrset(), so
this change avoids an assertion failure for invalid system files.

sys-file-reader: Fix double-free on read of partial record.

partial_record() does a longjmp() to code near the top of
sys_file_casereader_read() that unrefs the case, but this code at the
end of sys_file_casereader_read() would have already unref'ed it once in
that case, resulting in a double-free.

hash-functions: Use C instead of preprocessor to test size of double.

I don't see a reason that this has to be done as an #if directive.  The
compiler should be easily able to optimize out the branch that will never
be taken.  This allows us to get rid of a configure check, so it seems
worthwhile to me.

q2c: T_RPAREN should be T_LPAREN for matching a left parenthesis.

Also add a test for this case on the T-TEST command, where the bug was
first reported.

Bug #32061.
Reported by Mindaugas <embar@super.lt>.
Reported by Chuck Kralowec <chuck.kralowec@gmail.com>.

Updated the Lithuanian translation from translationproject.org.

README: Describe meaning of copyright year ranges.

This is required by the GNU maintainers guide as a prerequisite for using
copyright year ranges.  So far, PSPP itself doesn't use ranges, but Gnulib
(which PSPP uses) does.

expressions: Fix test failures due to new year.

Some of the date-related test cases assumed that year 41 would be
interpreted as 1941, but due to the 30-year century window, as soon as it
became 2011 this assumption failed.  Write these years explicitly as 1941
instead to fix the problem.

NPAR TESTS: Fix two test failures.

Tests "NPAR TESTS CHISQUARE with DESCRIPTIVES" and "NPAR TESTS CHISQUARE,
listwise missing" were failing because of some unexpected behavior of
lex_put_back().  This fixes the problem by avoiding lex_put_back()
entirely.

NPAR TESTS: Fix "NPAR TESTS BINOMIAL, P = 0.5; N1/N2 < 1" test failure.

lexer: Fix GCC warning for unhandled TOKEN_N_TYPES in lex_token_name().

lexer: Remove unused function lex_put_back_id().

value-parser: Remove redundant call to lex_force_string() in parse_value().

GET DATA: Fix punctuation in error message.

AGGREGATE: Align arg_func_tab[] in columns.

This makes the code more readable.  It should not change PSPP behavior.

i18n: Remove unnecessary #ifs.

The test for LC_MESSAGES should not be necessary because Gnulib ensures
that LC_MESSAGES is always defined.

The test for ENABLE_NLS should not be necessary because PSPP has not
supported that configuration for some time.

ECHO: Use text_item, as intended.

TEXT_ITEM_ECHO is meant for use by ECHO but it had been overlooked
accidentally until now.

float-format: Don't translate test strings.

These aren't visible to users in normal operation, so we might as well not
burden translators with them.

DO REPEAT: Make this command usable anywhere.

DO REPEAT just does macro expansion so there's no reason to limit it to
just after an active dataset has been defined.

identifier: New function token_type_to_string().

This is useful for debugging and testing code.

NPAR TESTS: Prefer lex_match_id() over lex_match_hyphenated_word()

This code used lex_match_hyphenated_word() in many places where it was
necessary to match a plain identifier.  But it is better to use
lex_match_id() when it can be, because it is simpler and faster, so this
commit does that.

q2c: Prefer lex_match_id() over lex_match_hyphenated_word() in emitted code.

Until now, q2c has used lex_match_hyphenated_word() wherever it was
necessary to match a plain identifier.  But it is better to use
lex_match_id() when it can be, because it is simpler and faster, so this
commit does that.

DEBUG XFORM FAIL: Issue an error message as part of transformation.

PSPP only returns a failure exit status if an error message is issued, but
DEBUG XFORM FAIL doesn't issue an error message.  This means that, if PSPP
has no other errors, then it's difficult to tell that the transformation
really did what it should have.  This commit fixes the potential problem.

INPUT PROGRAM: Remove unused enumeration.

expressions: Make extract_min_valid() parameter const.

This fixes the following warning:

parse.c: In function ‘parse_function’:
parse.c:1213: warning: passing argument 1 of ‘extract_min_valid’ discards qualifiers from pointer target type

categoricals: Make parameter to categoricals_done() const.

From a high-level point of view, categoricals_done() does not actually
mutate any data in a categoricals object.  Instead, it just computes a
cache.  So it seems reasonable to make it take a "const" parameter, and
this fixes a warning:

oneway.c: In function ‘run_oneway’:
oneway.c:502: warning: initialization discards qualifiers from pointer target type

covariance: Fix const-ness of covariance_calculate[_unnormalized] retval.

The covariance_calculate() and covariance_calculate_unnormalized()
functions documented that their return values were owned by the covariance
object itself and thus should not be freed by the caller.  However, this
documentation was incorrect, because in fact the covariance object did not
retain the pointer at all.  This commit fixes the comments, updates
the return values to be non-"const", and changes the callers to free the
returned "gsl_matrix" objects.

ONEWAY: Fix warning for passing "const" pointer as non-const parameter.

mann-whitney: Suppress GCC warning about unused parameter.

friedman: Fix GCC warning about uninitialized fr.w.

On my machine GCC 4.4 complains:
friedman.c: In function ‘friedman_execute’:
friedman.c:106: warning: ‘fr.w’ may be used uninitialized in this function

This appears to be because GCC can't see that the assignment to fr.w and
its later use (in show_sig_box()) both have the same condition.  At any
rate, this commit suppresses the warning by always initializing fr.w.

gui: Factor out duplicated code for executing and pasting syntax.

Reducing code duplication is good on its own.  This will also make it
easier in upcoming patches to swap out "getl_interface" with a new
structure, by eliminating most of the references to getl_interface.

command: Don't allow SORT as an abbreviation for SORT CASES.

This abbreviation has never been documented, and I don't see a reason to
keep it.

Remove the PROMPT, CPROMPT, and DPROMPT settings.

These settings will be insufficient to configure prompting for the new
lexer, which is able to detect more special cases in syntax and report
them through the prompt.  (However, if users actually want this feature,
then we could add it; it's not difficult.)

Remove the NULLINE and ENDCMD settings.

These settings change the lexical structure of the language, which makes
lexical analysis difficult.

VALUE LABELS: Relax limit on value label length from 60 bytes to 255.

Requested by friedrich nietzsche <f_nietsje@hotmail.com>.
With improvements by John Darrington.

lexer: Change the functions for retrieving token strings.

Until now, lex_tokid() has been for T_ID tokens only and lex_tokstr() has
been for T_ID and T_STRING tokens.  For T_ID tokens, lex_tokid() and
lex_tokstr() had slightly different semantics.

This doesn't entirely make sense, and these particular functions are not
the ones wanted most by clients, so this commit removes these functions
in favor of lex_tokcstr() and lex_tokss(), which are both applicable
to both T_ID and T_STRING tokens, with the same semantics in each case.

These functions are also easier for the upcoming reimplementation of the
lexer.

lexer: Get rid of lex_negative_to_dash().

This function stands in the way of replacing the lexer in a
straightforward way, because it disrupts the stream of tokens: the
lexer can't tell in advance whether, e.g., "-4" is one token or
two.  Fortunately, it is not used in very many places and is
relatively easy to remove.

lexer: New type enum token_type.

It seems useful to have a type that indicates that a value is a token.
Furthermore, being able to enumerate all of the possible tokens in a
straightforward way seems worthwhile.  It also makes it possible for
GCC to check "switch" statements on token types and to build arrays
indexed by token.

command: Factor command name matching out of command.c.

Making command parsing into a library will allow other code to use
the same functionality, which will be useful later in the lexer.
It also simplifies parsing command names and allows us to easily
add tests for command name parsing.

The new command name parsing code supports UTF-8.  This is not useful yet,
because its only client does not feed it UTF-8 strings, but it will be
useful later when the rest of the lexer is rewritten, where it will gain
another client that does feed it UTF-8.

identifier: Add some functions for Unicode syntax.

str: Add some functions for handling UTF-8.

str: Change "char" to "byte" in function names.

As PSPP moves toward using UTF-8 pervasively for command syntax, a
character is no longer always a byte, so this naming is clearer.

str: Inline some trivial functions.