ctime(3)

NAZWA
asctime, ctime, gmtime, localtime, mktime, asctime_r, ctime_r, gmtime_r, localtime_r - konwertuje daty i czas do postaci czasu rozłożonego lub ASCII

BIBLIOTEKA
Standardowa biblioteka C (libc, -lc)

SKŁADNIA
#include <time.h>

char *asctime(const struct tm *tm);
char *asctime_r(const struct tm *restrict tm,
                    char buf[restrict 26]);

char *ctime(const time_t *timep);
char *ctime_r(const time_t *restrict timep,
                    char buf[restrict 26]);

struct tm *gmtime(const time_t *timep);
struct tm *gmtime_r(const time_t *restrict timep,
                    struct tm *restrict result);

struct tm *localtime(const time_t *timep);
struct tm *localtime_r(const time_t *restrict timep,
                    struct tm *restrict result);

time_t mktime(struct tm *tm);

    Wymagane ustawienia makr biblioteki glibc (patrz feature_test_macros(7)):

asctime_r(), ctime_r(), gmtime_r(), localtime_r():
    _POSIX_C_SOURCE
        || /* glibc w wersji <= 2.19: */ _BSD_SOURCE || _SVID_SOURCE

OPIS
Funkcje ctime(), gmtime() oraz localtime() przyjmują argument typu time_t, reprezentujący czas kalendarzowy. Zinterpretowany jako bezwzględna wartość czasu określa liczbę sekund, jakie upłynęły od początku epoki, to jest od 1970-01-01 00:00:00 +0000 (UTC).

Funkcje asctime() oraz mktime() przyjmują jako argument czas rozłożony, który jest reprezentacją podzieloną na rok, miesiąc, dzień itd.

Czas rozłożony jest przechowywany w strukturze tm, opisanej w podręczniku tm(3type).

Wywołanie ctime(t) jest równoważne asctime(localtime(t)). Przekształca czas kalendarzowy t na zakończony znakiem null łańcuch o postaci

    "śro, sty 30 21:49:08 1993\n"

Skróty dni tygodnia to "nie", "pon", "wto", "śro", "czw", "pią" i "sob". Skróty miesięcy to "sty", "lut", "mar", "kwi", "maj", "cze", "lip", "sie", "wrz", "paź", "lis" i "gru". Zwracany jest wskaźnik do statycznego łańcucha, który może zostać nadpisany przy kolejnym wywołaniu dowolnej funkcji daty i czasu. Funkcja ustawia również zewnętrzne zmienne tzname, timezone i daylight tak, jakby wywoływała tzset(3). Wielowątkowa wersja tej funkcji, ctime_r(), robi to samo, ale zapisuje łańcuch w podanym przez użytkownika buforze, który powinien móc pomieścić co najmniej 26 znaków. Nie musi ona ustawiać zmiennych tzname, timezone, i daylight.

Funkcja gmtime() przekształca czas kalendarzowy timep na czas rozłożony, wyrażony w Coordinated Universal Time (UTC). Może zwrócić wartość NULL, jeśli rok nie daje się zapisać jako liczba całkowita. Zwracany jest wskaźnik do statycznej struktury, która to struktura może zostać nadpisana przy kolejnym wywołaniu dowolnej funkcji daty i czasu. Funkcja gmtime_r() robi to samo, ale zapisuje dane do struktury podanej przez użytkownika.

Funkcja localtime() przekształca czas kalendarzowy timep na czas rozłożony, wyrażony względem wybranej przez użytkownika strefy czasowej. Funkcja ustawia również zewnętrzne zmienne tzname, timezone i daylight tak, jakby wywoływała tzset(3). Zwracany jest wskaźnik do statycznej struktury, która może zostać nadpisana przy kolejnym wywołaniu dowolnej funkcji daty i czasu. Funkcja localtime_r() robi to samo, ale zapisuje dane do struktury podanej przez użytkownika. Nie musi ona ustawiać zmiennych tzname, timezone i daylight.

Funkcja asctime() przekształca czas rozłożony tm na zakończony bajtem null łańcuch tego samego formatu, co ctime(). Zwracany jest wskaźnik do statycznego łańcucha, który to łańcuch może zostać nadpisany przy kolejnym wywołaniu dowolnej funkcji daty i czasu. Funkcja asctime_r() robi to samo, ale zapisuje łańcuch w podanym przez użytkownika buforze o długości co najmniej 26 bajtów.

Funkcja mktime() przekształca strukturę czasu rozłożonego, wyrażoną w czasie lokalnym, na czas kalendarzowy. Funkcja ignoruje podane przez wywołującego wartości elementów tm_wday oraz tm_yday. Wartość podana w polu tm_isdst informuje funkcję mktime() o tym, czy dla czasu podanego w strukturze tm używany był czas letni (DST - daylight saving time), czy też nie był używany: wartość dodatnia oznacza, że DST był używany, zero - że nie był, a wartość ujemna nakazuje funkcji mktime() podjęcie próby sprawdzenia (w systemowej bazie danych informacji o strefach czasowych), czy DST był używany w podanym czasie. Odpowiednikiem tej funkcji w UTC jest timegm(3).

Funkcja mktime() modyfikuje pola struktury tm jak następuje: tm_wday i tm_yday są ustawiane na wartości określane na podstawie wartości innych pól. Jeśli elementy struktury mają wartości spoza zakresu wartości dopuszczalnych, to zostaną znormalizowane (w taki sposób, że np. 40 października zostanie zamieniony na 9 listopada). tm_isdst jest ustawiane (niezależnie od jej początkowej wartości) na wartość dodatnią lub na 0, aby wskazać - odpowiednio - czy w podanym czasie DST był używany, czy też nie był. Funkcja ustawia również zewnętrzne zmienne tzname, timezone i daylight tak, jakby wywoływała tzset(3).

Jeśli podany czas rozłożony nie może być reprezentowany jako czas kalendarzowy (sekundy od początku epoki), mktime() zwraca (time_t) -1 i nie zmienia pól w podzielonej strukturze czasu.

WARTOŚĆ ZWRACANA
gmtime() oraz localtime(), gdy się zakończą pomyślnie, zwracają wskaźnik do struct tm.

gmtime_r() oraz localtime_r(), gdy się zakończą pomyślnie, zwracają adres struktury wskazywanej przez result.

asctime() oraz ctime(), gdy się zakończą pomyślnie, zwracają wskaźnik do łańcucha znaków

asctime_r() oraz ctime_r(), gdy się zakończą pomyślnie, zwracają wskaźnik do łańcucha znaków, na który wskazuje argument buf.

mktime, gdy zakończy się pomyślnie, zwraca czas kalendarzowy (w sekundach od początku epoki [tj. 1970-01-01 00:00:00 +0000 -przyp. tłum.]), wyrażony jako wartość typu time_t

W razie błędu, mktime() zwraca wartość (time_t) -1 i pozostawia składową tm->tm_wday bez modyfikacji. Pozostałe funkcje w przypadku błędu zwracają NULL. Ustawiane jest też errno, wskazując błąd.

BŁĘDY

EOVERFLOW
    Wynik jest niereprezentowalny.

ATRYBUTY
Informacje o pojęciach używanych w tym rozdziale można znaleźć w podręczniku attributes(7).
Interfejs | Atrybut | Wartość
asctime() | Bezpieczeństwo wątkowe | MT-niebezpieczne race:asctime locale
asctime_r() | Bezpieczeństwo wątkowe | MT-bezpieczne locale
ctime() | Bezpieczeństwo wątkowe | MT-niebezpieczne race:tmbuf race:asctime env locale
ctime_r(), gmtime_r(), localtime_r(), mktime() | Bezpieczeństwo wątkowe | MT-bezpieczne env locale
gmtime(), localtime() | Bezpieczeństwo wątkowe | MT-niebezpieczne race:tmbuf env locale

WERSJE
POSIX nie określa parametrów ctime_r() jako restrict; jest to typowe dla glibc.

Wiele implementacji, włączając glibc, interpretuje 0 w tm_mday jako ostatni dzień poprzedniego miesiąca.

Według POSIX.1, localtime() musi się zachowywać tak, jakby tzset(3) było wywołane, w przypadku zaś localtime_r() nie ma takiego wymagania. W przenośnym kodzie tzset(3) powinno być wywołanie przed localtime_r().

STANDARDY

asctime()
ctime()
gmtime()
localtime()
mktime()
    C23, POSIX.1-2024.

gmtime_r()
localtime_r()
    POSIX.1-2024.

asctime_r()
ctime_r()
    Brak.

HISTORIA

gmtime()
localtime()
mktime()
    C89, POSIX.1-1988.

asctime()
ctime()
    C89, POSIX.1-1988. Oznaczone jako przestarzałe w C23 i w POSIX.1-2008 (z zaleceniem stosowania strftime(3)).

gmtime_r()
localtime_r()
    POSIX.1-1996.

asctime_r()
ctime_r()
    POSIX.1-1996. Oznaczone jako przestarzałe w POSIX.1-2008. Usunięte w POSIX.1-2024 (zalecając strftime(3)).

ZASTRZEŻENIA

  Bezpieczeństwo wątkowe
Następujące cztery funkcje acstime(), ctime(), gmtime() i localtime() zwracają wskaźnik do statycznych danych i w związku z tym nie są przystosowane do wielowątkowości. Wielowątkowe wersje acstime_r(), ctime_r(), gmtime_r() i localtime_r() są wymienione w SUSv2.

POSIX.1 mówi: "Funkcje asctime(), ctime(), gmtime() oraz localtime() powinny zwrócić wartości w jednym z dwóch statycznych obiektów: podzielonej strukturze czasu i tablicy znaków typu char. Wywołanie którejkolwiek z tych funkcji zwracającej wskaźnik do jednego z tych obiektów, może nadpisać informacje w którymkolwiek z obiektów tego samego typu, na który wskazuje wartość zwrócona przez dowolne poprzednie wywołanie którejkolwiek z funkcji". Może się to zdarzyć w implementacji zastosowanej w bibliotece glibc.

  mktime()
(time_t) -1 może reprezentować prawidłowy czas (jedna sekunda przed Epoką). Aby sprawdzić, czy mktime() zawiodło, konieczne jest użycie pola tm->tm_wday. Zob. przykładowy program w PRZYKŁADACH.

Obsługa nieujemnego tm_isdst w mktime() jest niedookreślona, a przekazanie wartości, która jest nieprawidłowa dla podanego czasu, daje nieokreślone skutki. Ponieważ mktime() jest jedną z niewielu funkcji wiedzących o tym, czy czas letni (DST) jest w mocy, przekazanie prawidłowej wartości może być trudne. Jednym z obejść tego problemu jest wywołanie mktime() dwukrotnie, raz z tm_isdst ustawionym na zero i raz z tm_isdst ustawionym na wartość dodatnią, a następnie odrzucenie wyników z wywołania, które go zmieni. Jeśli żadne z wywołań nie zmieni tm_isdst, to podany czas prawdopodobnie wypada w okresie przejściowym, gdy następuje początek lub koniec czasu letniego, zatem oba wyniki są prawidłowe, ale oznaczają dwa różne punkty w czasie. Jeśli oba wywołania go zmieniają, może to być również okres przejściowy czasu letniego, albo jakiś inny powód, z którego podany czas nie istnieje.

Określenie stref czasowych i czasu letniego zależy od lokalnych rządów, często się zmienia i może zawierać nieciągłości poza możliwością udokumentowania przez mktime. Na przykład zmiana w definicji strefy czasowej może spowodować powtórzenie lub pominięcie czasu zegara, bez odpowiadającej zmiany czasu letniego.

PRZYKŁADY
Poniższy program definiuje opakowanie pozwalające na wykrycie czasów nieprawidłowych i niejednoznacznych, z błędami, odpowiednio, EINVAL i ENOTUNIQ.

Poniższa sesja powłoki pokazuje przykładowy przebieg programu:

    $ TZ=UTC ./a.out 1969 12 31 23 59 59 0;
    -1
    $
    $ export TZ=Europe/Madrid;
    $
    $ ./a.out 2147483647 2147483647 00 00 00 00 -1;
    a.out: mktime: Value too large for defined data type
    $
    $ ./a.out 2024 08 23 00 17 53 -1;
    1724365073
    $ ./a.out 2024 08 23 00 17 53 0;
    a.out: my_mktime: Invalid argument
    1724368673
    $ ./a.out 2024 08 23 00 17 53 1;
    1724365073
    $
    $ ./a.out 2024 02 23 00 17 53 -1;
    1708643873
    $ ./a.out 2024 02 23 00 17 53 0;
    1708643873
    $ ./a.out 2024 02 23 00 17 53 1;
    a.out: my_mktime: Invalid argument
    1708640273
    $
    $ ./a.out 2023 03 26 02 17 53 -1;
    a.out: my_mktime: Invalid argument
    1679793473
    $
    $ ./a.out 2023 10 29 02 17 53 -1;
    a.out: my_mktime: Name not unique on network
    1698542273
    $ ./a.out 2023 10 29 02 17 53 0;
    1698542273
    $ ./a.out 2023 10 29 02 17 53 1;
    1698538673
    $
    $ ./a.out 2023 02 29 12 00 00 -1;
    a.out: my_mktime: Invalid argument
    1677668400

  Kod źródłowy programu: mktime.c
    #include <err.h>
    #include <errno.h>
    #include <stdint.h>
    #include <stdio.h>
    #include <stdlib.h>
    #include <string.h>
    #include <time.h>

    #define is_signed(T)  ((T) -1 < 1)

    static time_t my_mktime(struct tm *tp);

    int
    main(int argc, char *argv[])
    {
        char       **p;
        time_t     t;
        struct tm  tm;

        if (argc != 8) {
            fprintf(stderr, "Użycie: %s rrrr mm dd GG MM SS czyletni\n", argv[0]);
            exit(EXIT_FAILURE);
        }

        p = &argv[1];
        tm.tm_year  = atoi(*p++) - 1900;
        tm.tm_mon   = atoi(*p++) - 1;
        tm.tm_mday  = atoi(*p++);
        tm.tm_hour  = atoi(*p++);
        tm.tm_min   = atoi(*p++);
        tm.tm_sec   = atoi(*p++);
        tm.tm_isdst = atoi(*p++);

        errno = 0;
        tm.tm_wday = -1;
        t = my_mktime(&tm);
        if (tm.tm_wday == -1)
            err(EXIT_FAILURE, "mktime");
        if (errno == EINVAL || errno == ENOTUNIQ)
            warn("my_mktime");

        if (is_signed(time_t))
            printf("%jd\n", (intmax_t) t);
        else
            printf("%ju\n", (uintmax_t) t);

        exit(EXIT_SUCCESS);
    }

    static time_t
    my_mktime(struct tm *tp)
    {
        int            e, isdst;
        time_t         t;
        struct tm      tm;
        unsigned char  wday[sizeof(tp->tm_wday)];

        e = errno;

        tm = *tp;
        isdst = tp->tm_isdst;

        memcpy(wday, &tp->tm_wday, sizeof(wday));
        tp->tm_wday = -1;
        t = mktime(tp);
        if (tp->tm_wday == -1) {
            memcpy(&tp->tm_wday, wday, sizeof(wday));
            return -1;
        }

        if (isdst == -1)
            tm.tm_isdst = tp->tm_isdst;

        if (   tm.tm_sec   != tp->tm_sec
            || tm.tm_min   != tp->tm_min
            || tm.tm_hour  != tp->tm_hour
            || tm.tm_mday  != tp->tm_mday
            || tm.tm_mon   != tp->tm_mon
            || tm.tm_year  != tp->tm_year
            || tm.tm_isdst != tp->tm_isdst)
        {
            errno = EINVAL;
            return t;
        }

        if (isdst != -1)
            goto out;

        tm = *tp;
        tm.tm_isdst = !tm.tm_isdst;

        tm.tm_wday = -1;
        mktime(&tm);
        if (tm.tm_wday == -1)
            goto out;

        if (tm.tm_isdst != tp->tm_isdst) {
            errno = ENOTUNIQ;
            return t;
        }
    out:
        errno = e;
        return t;
    }

ZOBACZ TAKŻE
date(1), gettimeofday(2), time(2), utime(2), clock(3), difftime(3), strftime(3), strptime(3), timegm(3), tzset(3), time(7)

TŁUMACZENIE
Tłumaczenie niniejszej strony podręcznika: Adam Byrtek <alpha@irc.pl>, Andrzej Krzysztofowicz <ankry@green.mf.pg.gda.pl>, Robert Luberda <robert@debian.org> i Michał Kułach <michal.kulach@gmail.com>

Niniejsze tłumaczenie jest wolną dokumentacją. Bliższe informacje o warunkach licencji można uzyskać zapoznając się z GNU General Public License w wersji 3 (https://www.gnu.org/licenses/gpl-3.0.html) lub nowszej. Nie przyjmuje się ŻADNEJ ODPOWIEDZIALNOŚCI.

Błędy w tłumaczeniu strony podręcznika prosimy zgłaszać na adres listy dyskusyjnej manpages-pl-list@lists.sourceforge.net.