Allow handler to be called on a key without '=' or ':' #87

weltling · 2019-10-03T19:14:35Z

The actual need on this is as follows. The INI file contains a special section containing all the sections in the file. That is used to validate the INI file itself. Eg

[list all]
section0
section1

[section0]
key=val

[section1]
key=val

For this to work, the keys in the list all section need to be passed to the handler, so they can be recorded and used later for the validation. This has been made configurable, so won't affect the default library behavior.

Thanks.

benhoyt · 2019-10-03T20:10:59Z

Hi @weltling, this is reasonable request - however, inih already has a ton of #if's and I'm a bit hesitant to add yet another one. Do you have control over your INI file? If so, could you simply add = signs with a blank value so it parses? For example:

[list all]
section0=
section1=

weltling · 2019-10-03T21:00:34Z

Hi @benhoyt, thanks for checking the PR.

Leaving aside that changing the INI spec for the particular project would likely have to go through some cycles, another part of the issue is that the file is used by different parties and at least one already uses a parser that supports this kind of behavior. I fully understand your point to not to pollute inih with #if's, so ofc it's up to you. I'll have to check, whether carrying teh patch would be a solution, or come up with something else. In any case, thanks for your work and a useful piece of software :)

Thanks.

benhoyt · 2019-10-03T21:04:36Z

Cool, let me know what you find and comment back here if you can't work around it.

bluca · 2019-10-04T09:37:26Z

@benhoyt would unconditionally allow value-less keys be an option? That way there's no extra ifdefs. There are precedents in other ini parsers support this.
Thanks!

benhoyt · 2019-10-04T11:06:11Z

Okay - I've looked at this a bit further and I'm reopening. I don't want to enable this by default, but I'm willing to add the #if version. Python's configparser (which inih is somewhat modeled after) flags this as an error by default too, but has an allow_no_value option to enable this mode. I'll request a couple of tweaks to the PR and the addition of tests -- reviewing now.

benhoyt

Made some comments. Two other things:

Please add some snapshot tests for this to tests/ and tests/unittest.[sh|bat]. I don't think there are actually tests for the current "error on no value" case, so be good to add that at the same time.
Please use 4-space tabs rather than actual tab characters to match the rest of the file.

benhoyt · 2019-10-04T11:06:43Z

ini.c

@@ -202,7 +202,12 @@ int ini_parse_stream(ini_reader reader, void* stream, ini_handler handler,
            }
            else if (!error) {
                /* No '=' or ':' found on name[=:]value line */
-                error = lineno;
+#if INI_ALLOW_KEY_WITHOUT_EQUAL


Let's call this INI_ALLOW_NO_VALUE to match Python's "allow_no_value" option.

benhoyt · 2019-10-04T11:07:26Z

ini.c

+#if INI_ALLOW_KEY_WITHOUT_EQUAL
+                *end = '\0';
+                name = rstrip(start);
+                if (!HANDLER(user, section, name, NULL))


You need to add a && !error here like the other HANDLER calls so that it returns the first error.

benhoyt · 2019-10-04T11:10:07Z

ini.c

+                name = rstrip(start);
+                if (!HANDLER(user, section, name, NULL))
+#endif
+			error = lineno;


This is clever :-) but the indentation not matching up is a bit weird. Can we do this instead?

#if INI_ALLOW_NO_VALUE *end = '\0'; name = rstrip(start); if (!HANDLER(user, section, name, NULL)) error = lineno; #else error = lineno; #endif

benhoyt · 2019-10-04T11:15:32Z

ini.h

@@ -134,6 +134,13 @@ int ini_parse_string(const char* string, ini_handler handler, void* user);
 #define INI_CALL_HANDLER_ON_NEW_SECTION 0
 #endif

+/* If a section contains a key without '=' or ':' signs, it would be not
+   passed to the handler. Setting the below to 1 will still call the handler
+   and explicitly set value to NULL. */


Let's change the wording here to match the style of the other ones:

/* Nonzero to allow a name without a value (no '=' or ':' on the line) and call the handler with value NULL in this case. Default is to treat no-value lines as an error. */

weltling · 2019-10-04T19:19:20Z

@benhoyt glad you change your mind :) I'm working on some tests, will update next days.

Thanks.

weltling · 2019-10-05T01:42:11Z

@benhoyt ready for the next round, I think. Please let me know, if something is missing.

Thanks.

benhoyt

Looking good, thanks! Just a few comments.

benhoyt · 2019-10-05T12:43:24Z

tests/unittest.sh

+
+gcc ../ini.c -DINI_ALLOW_NO_VALUE=1 unittest.c -o unittest_call_allow_no_value
+./unittest_call_allow_no_value > baseline_call_allow_no_value.txt
+rm -f unittest_call_allow_no_value


This test and the committed .txt file shouldn't have the word "call" in it. Should be called just unittest_allow_no_value.

tests/unittest.c

tests/baseline_stop_on_first_error.txt

weltling · 2019-10-05T13:30:28Z

Everything should be resolved now. Thanks for the quick check.

benhoyt

Great, thank you!

benhoyt · 2019-10-05T14:26:50Z

Thanks for this -- I'll merge and release a new version shortly.

weltling · 2019-10-05T15:41:55Z

Thanks a lot!

benhoyt · 2019-10-05T20:12:15Z

Released r46 with this feature: https://github.com/benhoyt/inih/releases/tag/r46 -- thanks!

Allow handler to be called on a key withouth '=' or ':'

4fe98ee

benhoyt closed this Oct 3, 2019

benhoyt reopened this Oct 4, 2019

benhoyt reviewed Oct 4, 2019

View reviewed changes

benhoyt changed the title ~~Allow handler to be called on a key withouth '=' or ':'~~ Allow handler to be called on a key without '=' or ':' Oct 4, 2019

Address the @benhoyt's comments

98f6e88

weltling added 2 commits October 5, 2019 03:30

Add test for INI_ALLOW_NO_VALUE and adapt the framework

d149639

Extend expected results and check in a new results file

555d2a5

benhoyt requested changes Oct 5, 2019

View reviewed changes

Rename unittest/baseline files, simplify output code

f49f887

benhoyt approved these changes Oct 5, 2019

View reviewed changes

benhoyt merged commit 82fdde3 into benhoyt:master Oct 5, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allow handler to be called on a key without '=' or ':' #87

Allow handler to be called on a key without '=' or ':' #87

weltling commented Oct 3, 2019

benhoyt commented Oct 3, 2019

weltling commented Oct 3, 2019

benhoyt commented Oct 3, 2019

bluca commented Oct 4, 2019

benhoyt commented Oct 4, 2019

benhoyt left a comment

benhoyt Oct 4, 2019

benhoyt Oct 4, 2019

benhoyt Oct 4, 2019

benhoyt Oct 4, 2019

weltling commented Oct 4, 2019

weltling commented Oct 5, 2019

benhoyt left a comment

benhoyt Oct 5, 2019

weltling commented Oct 5, 2019

benhoyt left a comment

benhoyt commented Oct 5, 2019

weltling commented Oct 5, 2019

benhoyt commented Oct 5, 2019

Allow handler to be called on a key without '=' or ':' #87

Allow handler to be called on a key without '=' or ':' #87

Conversation

weltling commented Oct 3, 2019

benhoyt commented Oct 3, 2019

weltling commented Oct 3, 2019

benhoyt commented Oct 3, 2019

bluca commented Oct 4, 2019

benhoyt commented Oct 4, 2019

benhoyt left a comment

Choose a reason for hiding this comment

benhoyt Oct 4, 2019

Choose a reason for hiding this comment

benhoyt Oct 4, 2019

Choose a reason for hiding this comment

benhoyt Oct 4, 2019

Choose a reason for hiding this comment

benhoyt Oct 4, 2019

Choose a reason for hiding this comment

weltling commented Oct 4, 2019

weltling commented Oct 5, 2019

benhoyt left a comment

Choose a reason for hiding this comment

benhoyt Oct 5, 2019

Choose a reason for hiding this comment

weltling commented Oct 5, 2019

benhoyt left a comment

Choose a reason for hiding this comment

benhoyt commented Oct 5, 2019

weltling commented Oct 5, 2019

benhoyt commented Oct 5, 2019