* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
- * version 2 of the License, or (at your option) any later version.
+ * version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
- * License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * License along with this library; if not, see <http://www.gnu.org/licenses/>.
*/
/*
#include <stdlib.h>
-#ifdef HAVE_UNISTD_H
+#ifdef G_OS_UNIX
#include <unistd.h>
-#endif /* HAVE_UNISTD_H */
+#endif /* G_OS_UNIX */
#ifdef HAVE_SYS_TIME_H
#include <sys/time.h>
/**
* g_timer_new:
- * @Returns: a new #GTimer.
*
* Creates a new timer, and starts timing (i.e. g_timer_start() is
* implicitly called for you).
+ *
+ * Returns: a new #GTimer.
**/
GTimer*
g_timer_new (void)
* @microseconds: return location for the fractional part of seconds
* elapsed, in microseconds (that is, the total number
* of microseconds elapsed, modulo 1000000), or %NULL
- * @Returns: seconds elapsed as a floating point value, including any
- * fractional part.
*
* If @timer has been started but not stopped, obtains the time since
* the timer was started. If @timer has been stopped, obtains the
* stopped. The return value is the number of seconds elapsed,
* including any fractional part. The @microseconds out parameter is
* essentially useless.
+ *
+ * Returns: seconds elapsed as a floating point value, including any
+ * fractional part.
**/
gdouble
g_timer_elapsed (GTimer *timer,
return total;
}
+/**
+ * g_usleep:
+ * @microseconds: number of microseconds to pause
+ *
+ * Pauses the current thread for the given number of microseconds.
+ *
+ * There are 1 million microseconds per second (represented by the
+ * #G_USEC_PER_SEC macro). g_usleep() may have limited precision,
+ * depending on hardware and operating system; don't rely on the exact
+ * length of the sleep.
+ */
void
g_usleep (gulong microseconds)
{
}
}
-/* converts a broken down date representation, relative to UTC, to
- * a timestamp; it uses timegm() if it's available.
+/* converts a broken down date representation, relative to UTC,
+ * to a timestamp; it uses timegm() if it's available.
*/
static time_t
mktime_utc (struct tm *tm)
* zone indicator. (In the absence of any time zone indication, the
* timestamp is assumed to be in local time.)
*
- * Return value: %TRUE if the conversion was successful.
+ * Returns: %TRUE if the conversion was successful.
*
* Since: 2.12
*/
g_return_val_if_fail (iso_date != NULL, FALSE);
g_return_val_if_fail (time_ != NULL, FALSE);
- /* Ensure that the first character is a digit,
- * the first digit of the date, otherwise we don't
- * have an ISO 8601 date */
+ /* Ensure that the first character is a digit, the first digit
+ * of the date, otherwise we don't have an ISO 8601 date
+ */
while (g_ascii_isspace (*iso_date))
iso_date++;
}
if (*iso_date != 'T')
- {
- /* Date only */
- if (*iso_date == '\0')
- return TRUE;
- return FALSE;
- }
+ return FALSE;
iso_date++;
* g_time_val_to_iso8601:
* @time_: a #GTimeVal
*
- * Converts @time_ into an ISO 8601 encoded string, relative to the
- * Coordinated Universal Time (UTC).
+ * Converts @time_ into an RFC 3339 encoded string, relative to the
+ * Coordinated Universal Time (UTC). This is one of the many formats
+ * allowed by ISO 8601.
+ *
+ * ISO 8601 allows a large number of date/time formats, with or without
+ * punctuation and optional elements. The format returned by this function
+ * is a complete date and time, with optional punctuation included, the
+ * UTC time zone represented as "Z", and the @tv_usec part included if
+ * and only if it is nonzero, i.e. either
+ * "YYYY-MM-DDTHH:MM:SSZ" or "YYYY-MM-DDTHH:MM:SS.fffffZ".
+ *
+ * This corresponds to the Internet date/time format defined by
+ * [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt),
+ * and to either of the two most-precise formats defined by
+ * the W3C Note
+ * [Date and Time Formats](http://www.w3.org/TR/NOTE-datetime-19980827).
+ * Both of these documents are profiles of ISO 8601.
+ *
+ * Use g_date_time_format() or g_strdup_printf() if a different
+ * variation of ISO 8601 format is required.
+ *
+ * If @time_ represents a date which is too large to fit into a `struct tm`,
+ * %NULL will be returned. This is platform dependent, but it is safe to assume
+ * years up to 3000 are supported. The return value of g_time_val_to_iso8601()
+ * has been nullable since GLib 2.54; before then, GLib would crash under the
+ * same conditions.
*
- * Return value: a newly allocated string containing an ISO 8601 date
+ * Returns: (nullable): a newly allocated string containing an ISO 8601 date,
+ * or %NULL if @time_ was too large
*
* Since: 2.12
*/
struct tm tm_;
#endif
time_t secs;
-
+
g_return_val_if_fail (time_->tv_usec >= 0 && time_->tv_usec < G_USEC_PER_SEC, NULL);
- secs = time_->tv_sec;
+ secs = time_->tv_sec;
#ifdef _WIN32
- tm = gmtime (&secs);
+ tm = gmtime (&secs);
#else
#ifdef HAVE_GMTIME_R
tm = gmtime_r (&secs, &tm_);
#endif
#endif
+ /* If the gmtime() call has failed, time_->tv_sec is too big. */
+ if (tm == NULL)
+ return NULL;
+
if (time_->tv_usec != 0)
{
/* ISO 8601 date and time format, with fractionary seconds:
projects / platform / upstream / glib.git / blobdiff