Dateibasiertes Konfigurationshandling in C (Unix)

Dies ist wahrscheinlich eine der häufigsten Aufgaben / Probleme beim Programmieren; Sie müssen die Konfiguration Ihrer Anwendung irgendwo speichern.

Während ich versuche, einen Webserver oder andere Anwendungen zu erstellen, möchte ich den Code so sauber wie möglich halten, da mein Hauptinteresse am Programmieren der Architektur gilt. Dies führt dazu, dass ich Konfigurationen in einer Datei speichern möchte, die geändert werden kann, ohne die Software neu kompilieren zu müssen.

Ich bin nicht hier, um das Rad neu zu erfinden oder so etwas, also würde ich gerne einen Konfigurationsleser in C auf *nix erstellen. Die Konfiguration kann der Konfiguration jeder anderen Software sehr ähnlich sein; Apache, vsftpd, MySQL usw.

Die grundlegende Frage ist: Wie liest man aus einer Textdatei und verarbeitet jede Zeile effizient (in reinem C)? Muss ich verwenden fgetc() und jedes Zeichen verarbeiten?

Hmm gibt es LibConfig.

Ich habe es in gefunden Wiki

Verschiedene Leute haben recht gute Ratschläge gegeben – das Pure-FTP-Beispiel ist interessant.

Sie sollten auch lesen TAOUP (Die Kunst der Unix-Programmierung) von ES Raymond. Es hat Beispiele für eine Fülle von Konfigurationsdateien. Es skizziert auch kanonische Redewendungen für die Konfigurationsdateien. Beispielsweise sollten Sie wahrscheinlich ‘#’ zulassen, um einen Kommentar am Ende der Zeile zu beginnen, und Leerzeilen ignorieren. Sie sollten auch entscheiden, was Sie tun, wenn die Konfigurationsdatei eine Zeile enthält, die Sie nicht verstehen – ob Sie ignorieren und stillschweigend fortfahren oder sich beschweren. (Ich bevorzuge Dinge, die sich beschweren; dann weiß ich, warum das, was ich gerade hinzugefügt habe, keine Wirkung hat – während stilles Ignorieren bedeutet, dass ich nicht weiß, ob der gerade hinzugefügte Eintrag eine Wirkung hat.)

Ein weiteres Problem ist das Auffinden der Konfigurationsdatei. Tun Sie das durch den einkompilierten Speicherort, durch einen Standardinstallationsspeicherort mit zu überschreibender Umgebungsvariable oder durch ein anderes Stück Magie? Stellen Sie sicher, dass es eine Befehlszeilenoption gibt, mit der die Konfigurationsdatei absolut angegeben werden kann – ziehen Sie sogar in Erwägung, dies als einzige Möglichkeit zu verwenden.

Ansonsten halten Sie es in weiten Grenzen einfach und alle sind glücklicher.

Okay, also kommen wir zum anderen Teil. Sie müssen darüber nachdenken, was Sie als Ihre “Sprache” haben möchten. In der UNIX-Welt ist die Art der kanonischen Version wahrscheinlich durch Leerzeichen getrennter Text (think /etc/hosts) oder “:” getrennter Text (wie /etc/passwd).

Sie haben ein paar Möglichkeiten, wobei die einfachste in gewisser Weise die Verwendung von scanf(3) ist. Lesen Sie erneut die Manpage für Details, aber wenn ein Zeileneintrag so etwas wie

port    100

dann suchst du sowas wie

char inbuf[MAXLINE];
int  val;

scanf("%s %d\n", &inbuf[0], &val);

Sie können etwas flexibler werden, wenn Sie einen einfachen FSA-Parse schreiben: Lesen Sie die Zeichen einzeln aus der Zeile und verwenden Sie einen endlichen Automaten, um zu definieren, was zu tun ist.

Okay, hier ist ein echtes Beispiel für C-Code:

/* demo-fgets -- read a "demo.text", copy to stdout with line
   numbers. */

#include <stdio.h>
#include <stdlib.h>

#define MAXLINE 100

FILE * fp;
char bufr[MAXLINE];

extern int errno ;

int main(int argc, char ** argv){
    int count = 0 ;
    if((fp = fopen("demo.text","r")) != NULL){
        /* then file opened successfully. */
        while(fgets(bufr,MAXLINE,fp)!=NULL){
            /* then no read error */
            count +=1;
            printf("%d: %s",     /* no "\n", why? */
                   count, bufr);
        }
        /* fgets returned null */
        if(errno != 0){
            perror(argv[0]);    /* argv[0]?  Why that? */
            exit(1);
        }
        exit(0);                /* EOF found, normal exit */
    } else {                    /* there was an error on open */
        perror(argv[0]);
        exit(1);
    }
}

Ich führe es mit dieser Eingabedatei aus:

520 $ cat demo.text 
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum
aliquet augue id quam. Sed a metus. Quisque sit amet quam. Sed id
ante. In egestas est non mi. Sed vel velit non elit vehicula
viverra. Curabitur eget tortor in ipsum vulputate
faucibus. Suspendisse imperdiet mauris at nibh. Sed interdum. Maecenas
vulputate, massa vel placerat mattis, ante est tincidunt sem, in
sollicitudin velit lacus non tortor. Etiam sagittis consequat nisl. 

Vestibulum id leo quis mauris gravida placerat. Donec aliquet justo a
tortor. Etiam nisi nibh, auctor non, luctus et, aliquam vitae,
metus. Cum sociis natoque penatibus et magnis dis parturient montes,
nascetur ridiculus mus. Nunc lacinia quam a ligula. Nulla quis nisi eu
nunc imperdiet cursus. Nunc vitae nisi vitae tellus posuere
sollicitudin. Nunc suscipit, dui ac interdum euismod, pede nisl varius
dui, sed mattis libero mauris eu felis. Nam mattis dui eget
nunc. Suspendisse malesuada, pede eget posuere pellentesque, neque
eros pretium nibh, ut blandit dui leo dapibus orci. Etiam lacinia
lectus at orci. Donec ligula lacus, sagittis nec, sodales et,
fringilla lobortis, eros. Etiam sit amet nulla. Aliquam mollis pede id
enim. Etiam ligula felis, pulvinar nec, vestibulum molestie, interdum
ut, urna. Ut porta ullamcorper diam. Nullam interdum arcu. 

Pellentesque habitant morbi tristique senectus et netus et malesuada
fames ac turpis egestas. Etiam eu enim quis sem accumsan
tristique. Proin non sem. Etiam quis ante. Aenean ornare pellentesque
dolor. Praesent sodales. Cras dui velit, scelerisque a, accumsan a,
vestibulum in, dui. Pellentesque sed sapien. Etiam augue est,
convallis eget, egestas vel, molestie id, turpis. Cum sociis natoque
penatibus et magnis dis parturient montes, nascetur ridiculus
mus. Cras posuere lorem eu diam. Ut ultricies velit. Nunc imperdiet
suscipit mauris. Vestibulum molestie elit id risus. Phasellus et
purus. Vestibulum id mauris. Fusce gravida elit quis turpis. Aliquam
ut est. 

Sed in mauris eu nulla rhoncus suscipit. Nam id dolor sit amet turpis
placerat sodales. Nunc ipsum. Quisque diam tellus, dapibus non,
interdum at, aliquam sit amet, tellus. Donec non pede eget massa
aliquam semper. Quisque dictum lacinia ipsum. Fusce magna purus,
mattis id, commodo et, lobortis eu, arcu. Vestibulum viverra neque a
nulla. Cum sociis natoque penatibus et magnis dis parturient montes,
nascetur ridiculus mus. Pellentesque vel felis in ligula blandit
auctor. Quisque quam. Curabitur turpis. Morbi molestie augue a
nisi. Nulla sollicitudin sagittis elit. Suspendisse in odio sed magna
dictum vestibulum. Duis facilisis lorem eget neque. Proin sit amet
urna eget velit scelerisque aliquam. Pellentesque imperdiet. Nullam
sapien. Nullam placerat ipsum eget metus. 

Mauris ornare risus eu velit. Morbi bibendum diam in sem. Morbi
aliquet nisl sit amet quam. Donec ornare sagittis nibh. Fusce ac
lectus. Sed sit amet risus. Integer facilisis commodo
sem. Pellentesque facilisis. Donec libero. Lorem ipsum dolor sit amet,
consectetur adipiscing elit.

Es gibt eine Reihe von Möglichkeiten. Du nicht müssen fgetc verwenden. Sie sollten wahrscheinlich die Manpage von stdio lesen, aber die kanonische Sache wäre, die Datei mit fopen(3) zu öffnen und dann mit fgets(3) zu lesen, um jeweils eine Zeile zu lesen. Das würde in etwa so aussehen:

#include <stdio.h>

FILE * fp ;
char bufr[MAXLINE];

if((fp = fopen(filename, "r") != NULL){
    while(! feof(fp)){
         fgets(bufr, MAXLINE, fp);
         /* Do stuff */
    }
} else {
    /* error processing, couldn't open file */
}

Könnte man sich auch anschauen libini bei Sourceforge.

Warum würdest du je Schreiben Sie diesen Code von Grund auf neu, es ist erledigt Also viele Male; Finden Sie einfach eine gute F/OSS-Implementierung und verwenden Sie diese.

Wie lesen Sie aus einer Textdatei und verarbeiten jede Zeile effizient

Machen Sie sich keine Sorgen um die Effizienz, es spielt keine Rolle für das Lesen von Konfigurationsdateien. Entscheiden Sie sich stattdessen für Einfachheit und Wartbarkeit.

So hätte ich es gemacht (Pseudo-Code):

while(there is input) {
  get one line;
  if (it is empty line || it beings with spaces followed by a '#') {
    skip this line, either empty or it's a comment;
  }
  find the position of the token that splits option name and its value;
  copy the option name and its value to separate variables;
  removing spaces before and after these variables if necessary;
  if (option == option1) {
     parse value for option 1;
  } else if (option == option2) {
     parse value for option 2;
  } else {
     handle unknown option name;
  }
  check consistency of options if necessary;
}

Beachten Sie, dass ein Teil des Codes (Prüfung auf leere Zeilen, Kommentare und Leerzeichen um Variablen) dazu da ist, Ihnen zusätzliche Flexibilität beim Schreiben der Konfigurationsdatei zu geben. Zum Beispiel werden Sie Ihr Programm nicht zum Absturz bringen, wenn Sie versehentlich hier und da ein zusätzliches Leerzeichen lassen.

Dies setzt voraus, dass Sie Konfigurationsdateien haben, die wie folgt aussehen:

# comment for option 1
option1 = value1

# comment for option 2
option2 = value2

...