Free Press

• NAME
• SYNOPSIS
• DESCRIPTION
• Funktion read_config_file
  • Syntax
  • Argumente
  • Rückgabewert
  • Beschreibung
• Hinweise
  • Funktion wird standardmäßig nicht exportiert
  • Migriert von ConfigFile in Config::File
• AUTHOR
• VERSION

Config::File – Parsen einer einfachen Konfigurationsdatei

use Config::File;

my $config_hash = Config::File::read_config_file($configuration_file);

DESCRIPTION

read_config_file parst eine einfache Konfigurationsdatei und speichert ihre Werte in einer anonymen Hash-Referenz. Die Syntax der Konfigurationsdatei ist wie folgt:

 # This is a comment VALUE_ONE = foo VALUE_TWO = $VALUE_ONE/bar VALUE_THREE = The value contains a \# (hash). # This is a comment.

Optionen können bei der Erstellung von Gruppen geclustert werden:

Dann können Werte mit dieser Syntax abgerufen werden:

 $hash_config->{CLUSTER_ONE}{data};

Es können so viele Unteroptionen in einem Cluster sein, wie benötigt werden.

 BIG_CLUSTER = data

wird abgerufen durch: $hash_config->{BIG_CLUSTER}{part1}{part2}{part3};

Es gibt ein paar Einschränkungen, was die Namen der Schlüssel angeht. Zunächst einmal sollten alle Zeichen alphabetisch, numerisch, Unterstriche oder Bindestriche sein, wobei eckige Klammern für die Clusterbildung zulässig sind. Das heißt, die Schlüssel sollten /^+$/

Das bedeutet auch, dass kein Leerzeichen im Schlüsselteil der Zeile erlaubt ist.

 CLUSTER_ONE = data cluster one # Right CLUSTER_ONE = data cluster one # Wrong

Funktion read_config_file

 Config::File::read_config_file($file);

Argumente

$file ist die Konfigurationsdatei.

Rückgabewert

Diese Funktion gibt eine Hash-Referenz zurück. Jeder Schlüssel des Hashes ist ein in der Konfigurationsdatei definierter Wert.

Beschreibung

read_config_fileparst eine Konfigurationsdatei und setzt einige Werte in eine Hash-Referenz.

Funktion wird standardmäßig nicht exportiert

In den Versionen bis 1.0 wurde die Funktion read_config_file in den Namensraum des aufrufenden Programms exportiert – ab Version 1.1 wird standardmäßig nichts exportiert. Man kann read_config_file entweder vollständig qualifizieren oder explizit in den eigenen Namespace importieren:

read_config_file vollständig qualifizieren

 use Config::File; my $config_hash = Config::File::read_config_file($configuration_file);

read_config_file explizit importieren

 use Config::File qw(read_config_file); my $config_hash = read_config_file($configuration_file);

Von ConfigFile zu Config::File migriert

Ab Version 1.4 habe ich mich, um dieses Modul in das CPAN aufzunehmen, dazu entschlossen, von dem sehr unüblichen Namen ConfigFile wegzukommen und das Modul in Config::File umzubenennen. Ein kleines Umleitungsmodul wurde eingebaut, so dass aktueller Code, der dieses Modul verwendet, nicht bricht, aber die Verwendung des ConfigFile-Namensraums ist veraltet (und wird daher eine Warnung ausgeben). Bitte aktualisieren Sie Ihren Code!

AUTHOR

Die Entwicklung wurde von Sebastien J. Gross <[email protected]> begonnen. Gepflegt von Gunnar Wolf <[email protected]> bis 2018, als die Universität Stockholm (Johan Wassberg und Mikael Nordin) die Pflege übernahm.

Alle Rechte vorbehalten. Dieses Programm ist freie Software; Sie können es unter den Bedingungen der GPL weiterverteilen und/oder verändern.

VERSION

Version 1.54 Copyright (c) 2002 Sebastien J. Gross. All rights reserved. Copyright (c) 2003-2018 Gunnar Wolf. All rights reserved. Copyright (c) 2018- Stockholm University. All rights reserved. Dieses Programm ist freie Software; Sie können es unter den Bedingungen der GPL v2 (oder später, nach Ihrer Wahl) weitergeben und/oder modifizieren.

 cpanm Config::File 

 perl -MCPAN -e shell install Config::File