Communities

Writing
Writing
Codidact Meta
Codidact Meta
The Great Outdoors
The Great Outdoors
Photography & Video
Photography & Video
Scientific Speculation
Scientific Speculation
Cooking
Cooking
Electrical Engineering
Electrical Engineering
Judaism
Judaism
Languages & Linguistics
Languages & Linguistics
Software Development
Software Development
Mathematics
Mathematics
Christianity
Christianity
Code Golf
Code Golf
Music
Music
Physics
Physics
Linux Systems
Linux Systems
Power Users
Power Users
Tabletop RPGs
Tabletop RPGs
Community Proposals
Community Proposals
tag:snake search within a tag
answers:0 unanswered questions
user:xxxx search by author id
score:0.5 posts with 0.5+ score
"snake oil" exact phrase
votes:4 posts with 4+ votes
created:<1w created < 1 week ago
post_type:xxxx type of post
Search help
Notifications
Mark all as read See all your notifications »
Code Reviews

Welcome to Software Development on Codidact!

Will you help us build our independent community of developers helping developers? We're small and trying to grow. We welcome questions about all aspects of software development, from design to code to QA and more. Got questions? Got answers? Got code you'd like someone to review? Please join us.

Comments on Counting number of assignments that a `fscanf` format strings implies

Parent

Counting number of assignments that a `fscanf` format strings implies

+4
−0

I'm writing a function that counts the number of assignments for a fscanf format string. I studied the documentation in C standard 7.21.6.2

It looks like it works. It passes all test cases I have written and yields no warnings with -Wall -Wextra -pedantic -std=c17. While I appreciate design advises, my main concern is if the code is correct or not, so I would be grateful if you found any test case that breaks it. Minor things like variable naming and such is not really interesting.

The function requires the format string to be valid. If not, the behavior is undefined.

#include <stdio.h>
#include <ctype.h>
#include <string.h>
#include <assert.h>

// Counts the number of assignments that should be made by scanf and alike.
//
// Assumes a valid format string. If it's not valid, behavior is undefined.

int count_assignments(const char *fmt) {
    int ret = 0;

    // Note that n is removed, because it suppresses assignments
    static const char specifiers[] = "diouxaefgcspAEFGX";
    static const char singlelength[] = "hljztL";
    static const char doublelength[] = "hl";

    while(*fmt) {
        if(*fmt == '%') { 
            fmt++;

            // Skip width modification
            while(isdigit(*fmt)) fmt++;

            // Check length modification
            if(strchr(singlelength, *fmt)) {
                fmt++;
                if(strchr(doublelength, *fmt)) {
                    fmt++;
                    goto READ_SPECIFIER;
                }
                goto READ_SPECIFIER;
            }
            if(*fmt == '[') {
                while(*fmt != ']') fmt++;
                ret++;
                goto END;
            }
            goto READ_SPECIFIER;
        }

        goto END;
        
    READ_SPECIFIER:
        if(strchr(specifiers, *fmt)) 
            ret++;
    END:
        fmt++;
    }

    return ret;
}

int main(void)
{
    struct test_case {
        const char *fmt;
        const int n;
    } test_cases[] = {
        { "foo", 0 },
        { "%s", 1 },
        { "%d%d", 2 },
        { "%lld", 1 },
        { "%%", 0 },
        { "%d%%%d", 2 },
        { "%2333d%c%33f", 3 },
        { "%[bar]", 1 }
    };

    for(size_t i=0; i<sizeof test_cases/sizeof test_cases[0]; i++) {
        struct test_case tc = test_cases[i];
        printf("%s %d %d\n", tc.fmt, tc.n, count_assignments(tc.fmt));
        assert(count_assignments(tc.fmt) == tc.n);
    }
}
History
Why does this post require attention from curators or moderators?
You might want to add some details to your flag.
Why should this post be closed?

2 comment threads

Handling `%%` in a `scanf()` format string? (1 comment)
General comments (2 comments)
Post
+3
−0

Just looking at your code, I think you'll need to look at a few nasties in scan sets:

  • %[^]%a-z] stops at the second ], not the first, for example, and I think your code would misconstrue the %a as a conversion rather than part of the scan set.
  • Likewise %[]%[a-z]; the one scan set there stops at the second ], but your code would count two scan sets, I believe.

You also need to know about %n (it's a conversion specifier, but it doesn't get counted). You've removed it from the list of conversion specifiers, so you may be OK with that (but your testing should test it).

You'll need to worry about suppressed conversions %23*f (which don't get counted either).

I think your code would accept %hld or %lhu as valid (whereas %hhd and %llu are valid — it should be two of the same length modifier). That's one specific case of the more general comment:

You are not validating the format — which is OK, as long as you know that's what you're (not) doing.

History
Why does this post require attention from curators or moderators?
You might want to add some details to your flag.

1 comment thread

General comments (4 comments)
General comments

Skipping 1 deleted comment.

klutt‭ wrote about 4 years ago

Hmmm, I don't think it's that important to test %n, but you definitely have a point in general about such things. I should not only test things that should work. I should also test things that should not work. I added tests including the asterisk: "%*d", "%23d" and "%23d" even though I'm not sure if the last one is valid or not. But it said 0 for all of them. I have not considered brackets within brackets. Good catch there, and I need to try it out and experiment a little.

klutt‭ wrote about 4 years ago

@MythicalProgrammer I just made some CRAZY testing that I need to show you. I was not comfortable with manually figuring out how many arguments a format string should have, but on the other hand, that's also the problem I'm trying to solve. But I did a workaound and made the program create a new .c file with a scanf call with the format string. The it compiled it, counted the warnings and used that. Have a look: https://pastebin.com/gWTapsm7

Mythical Programmer‭ wrote about 4 years ago · edited about 4 years ago

@klutt — I took your code from PasteBin and added a test for %s%n (expecting 1), and got the output %s%n 1 1 2 followed by an assertion failure for (count == warnings). The trouble is that %n requires a matching int * argument, but it doesn't get counted as a conversion.

klutt‭ wrote about 4 years ago · edited about 4 years ago

@MythicalProgrammer Truth to be told, you discovered a bug, but not the one you think. It's a bug in the specification. I was not looking for number of assignments. I was looking for number of arguments that should be passed and wrongly assumed they were the same. So the fix is to put n back and change the name of the function. Thank you so much. I have made some other fixes to that's not uploaded yet.