aboutsummaryrefslogtreecommitdiff
path: root/src/options.c
blob: 93f0ceb5f43e2496387c6fb48949d8aaed52c754 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
/* SPDX-License-Identifier: Apache-2.0 */

/* Copyright 2025 Thorsten Töpper
 *
 * vim:ts=4:sw=4:expandtab
 */
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <getopt.h>
#include <stdbool.h>
#include <ctype.h>

#include "output.h"
#include "options.h"



/* === GLOBAL VARIABLES === */
struct option long_options[] = {
    { "help", no_argument, 0, 0 },
    { "format-string", required_argument, 0, 0 },
    { "long-timestamp", no_argument, 0, 0 },
    { "reverse-sort", no_argument, 0, 0 },
    { "show-hidden-entries", no_argument, 0, 0 },
    { "sort-by", required_argument, 0, 0 },
    { "time-field", required_argument, 0, 0 },
    { 0, 0, 0, 0 }
};

bool option_sort_reverse_order = false;
enum esort_type option_sort_type = SORT_BY_SIZE;
bool option_show_hidden_entries = false;
bool option_timestamp_long = false;
char *option_format_string = NULL;

/* There are three fields regarding time, valid values 'a','c', 'm':
 * st_atime / st_atim.tv_sec - time of the last access
 * st_ctime / st_ctim.tv_sec - time of the last change to the inode
 * st_mtime / st_mtim.tv_sec - time of last modification of the content
 */
char option_time_field = 'm';

char *exec_name;

/* === IMPLEMENTATION === */

void usage(char *executable) {
    fprintf(stderr, "Call: %s OPTIONS path_to_open\n", executable);
    fprintf(stderr, "\nOPTIONS are\n");
    /* long name, short name, optional argument, explanation */
    fprintf(stderr, " %-25s %2s %10s  - %s\n", "--help", "-h", "",
            "Show this message and exit");
    fprintf(stderr, " %-25s %2s %10s  - %s\n", "--format-string", "", "format",
            "define columns to print, details below");
    fprintf(stderr, " %-25s %2s %10s  - %s\n", "--long-timestamp", "-t", "",
            "Print timestamp in long form yyyymmdd HH:MM:SS ZONE");
    fprintf(stderr, " %-25s %2s %10s  - %s\n", "--reverse-sort", "", "",
            "Sort reversed");
    fprintf(stderr, " %-25s %2s %10s  - %s\n", "--show-hidden-entries", "-v", "",
            "Show hidden entries in the directory");
    fprintf(stderr, " %-25s %2s %10s  - %s\n", "--sort-by", "", "variant",
            "Sort either by size or time");
    fprintf(stderr, " %-25s %2s %10s  - %s\n", "--time-field", "", "a|c|m",
            "Sort by (a)ccess, (c)hange or (m)odification time. Default: m");

    /* fputc_width_x('-', 72, stderr); */

    fprintf(stderr, "\n\n--sort-by variants: name | size | time\n");

    fprintf(stderr, "\n--format-string: Characters unlike the following are ignored\n");
    fprintf(stderr, " n - name\n");
    fprintf(stderr, " s - size\n");
    fprintf(stderr, " t - time defined by --time-field (default: modification time)\n");
    fprintf(stderr, " A - access time\n");
    fprintf(stderr, " C - change time\n");
    fprintf(stderr, " M - modification time\n");
    fprintf(stderr, " T - type\n");
}


void set_option(const char *option_name, char *option_argument) {

    DBGTRC("DEBUG: called with option_name '%s' and option_argument '%s'\n",
            option_name, option_argument);

    if (option_name == NULL)
        return;

    /* options WITHOUT arguments */
    if (strcmp("help", option_name) == 0) {
        usage(exec_name);
        exit(EXIT_SUCCESS);
    }

    if (strcmp("long-timestamp", option_name) == 0) {
        option_timestamp_long = true;
        return;
    }

    if (strcmp("reverse-sort", option_name) == 0) {
        option_sort_reverse_order = true;
        return;
    }

    if (strcmp("show-hidden-entries", option_name) == 0) {
        option_show_hidden_entries = true;
        return;
    }

    /* options WITH arguments */
    if (option_argument == NULL || option_argument[0] == '\0') {
        LOGERR("ERROR: option_name %s with missing option_argument\n",
                option_name);
        exit(EXIT_FAILURE);
    }

    if (strcmp("format-string", option_name) == 0) {
        option_format_string = option_argument;
        return;
    }

    if (strcmp("sort-by", option_name) == 0) {
        if (strncmp("name", option_argument, 4) == 0) {
            option_sort_type = SORT_BY_NAME;
        } else if (strncmp("size", option_argument, 4) == 0) {
            option_sort_type = SORT_BY_SIZE;
        } else if (strncmp("time", option_argument, 4) == 0) {
            option_sort_type = SORT_BY_TIME;
        } else {
            LOGERR("WARNING: '%s' is an invalid argument for %s\n",
                    option_argument, option_name);
        }
        return;
    }

    if (strcmp("time-field", option_name) == 0) {
        switch (option_argument[0]) {
            case 'a':
                option_time_field = 'a';
                break;
            case 'c':
                option_time_field = 'c';
                break;
            case 'm':
                option_time_field = 'm';
                break;
            default:
                /* Keep in mind: isgraph ignores space, but an explicit call --time-field ' ' is strange */
                LOGERR("WARNING: --time-field: invalid value %c 0x%02X - falling back to default m\n",
                    ((isgraph(option_argument[0])) ? option_argument[0] : ' '), option_argument[0]);
                option_time_field = 'm';
                break;
        };
        return;
    }

    LOGERR("ERROR: Option '%s' not recognized\n.", option_name);
}


int parse_arguments(int argc, char **argv) {
    int c = 0, index;
    /* exec_name is a file internal global variable for --help in set_option() */
    exec_name = argv[0];

    while(1) {
        index = 0;
        c = getopt_long(argc, argv, "htv", long_options, &index);

        if (c == -1) {
            break;
        }

        switch (c) {
            case 0:
                set_option(long_options[index].name, optarg);
                break;
            case 'h':
                usage(exec_name);
                exit(EXIT_SUCCESS);
            case 't':
                option_timestamp_long = true;
                break;
            case 'v':
                option_show_hidden_entries = true;
                break;
            case '?':
                break;
            default:
                LOGERR("ERROR: unrecognized option 0x%02X '%c'\n", c, c);
                usage(exec_name);
                exit(EXIT_FAILURE);
        }
    }

    return optind;
}