xlnt
date.hpp
1 // Copyright (c) 2014-2022 Thomas Fussell
2 // Copyright (c) 2024 xlnt-community
3 //
4 // Permission is hereby granted, free of charge, to any person obtaining a copy
5 // of this software and associated documentation files (the "Software"), to deal
6 // in the Software without restriction, including without limitation the rights
7 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 // copies of the Software, and to permit persons to whom the Software is
9 // furnished to do so, subject to the following conditions:
10 //
11 // The above copyright notice and this permission notice shall be included in
12 // all copies or substantial portions of the Software.
13 //
14 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
20 // THE SOFTWARE
21 //
22 // @license: http://www.opensource.org/licenses/mit-license.php
23 // @author: see AUTHORS file
24 
25 #pragma once
26 
27 #include <string>
28 
29 #include <xlnt/xlnt_config.hpp>
30 #include <xlnt/utils/calendar.hpp>
31 
32 namespace xlnt {
33 
39 struct XLNT_API date
40 {
45  static date today();
46 
51  static date from_number(int days_since_base_year, calendar base_date);
52 
56  date(int year_, int month_, int day_);
57 
61  date() = default;
62 
67  int to_number(calendar base_date) const;
68 
74  int weekday() const;
75 
80  int get_year() const;
81 
86  int get_month() const;
87 
92  int get_day() const;
93 
97  bool is_null() const
98  {
99  return _is_null;
100  }
101 
105  bool operator==(const date &comparand) const;
106 
110  bool operator!=(const date &comparand) const;
111 
112 
114 
118  int year = 0;
119 
123  int month = 0;
124 
128  int day = 0;
129 
130 
131 private:
132 
136  bool _is_null = true;
137 };
138 
139 } // namespace xlnt
bool is_null() const
Returns whether the date is in an empty/invalid state.
Definition: date.hpp:97
Enumerates the possible types a cell can be determined by it&#39;s current value.
Definition: cell.hpp:37
bool operator==(std::nullptr_t, const cell &cell)
Returns true if this cell is uninitialized.
value is an ISO 8601 formatted date
bool operator!=(const std::string &reference_string, const range_reference &ref)
Returns true if the string representation of the range is not equivalent to ref.
A date is a specific day specified in terms of a year, month, and day. It can also be initialized as ...
Definition: date.hpp:39
calendar
An enumeration of possible base dates. Dates in Excel are stored as days since this base date...
Definition: calendar.hpp:35