plugins/fn-hebrew-date/hdate.h

   1 /*
   2  * hdate_hdate.c: convert georgean and hebrew calendars.
   3  *
   4  * Author:
   5  *   Yaacov Zamir <kzamir@walla.co.il>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, see <https://www.gnu.org/licenses/>.
  19  */
  20
  21
  22 #ifndef __HDATE_H__
  23 #define __HDATE_H__
  24
  25 #ifdef __cplusplus
  26 extern "C"
  27 {
  28 #endif
  29
  30 /**
  31  @brief Return the days from the start
  32
  33  @param y The years
  34  @warning internal function.
  35 */
  36 int
  37 hdate_days_from_start (int y);
  38
  39 /**
  40  @brief compute hebrew date from gregorian date
  41
  42  @param d Day of month 1..31
  43  @param m Month 1..12 ,  if m or d is 0 return current date.
  44  @param y Year in 4 digits e.g. 2001
  45  */
  46 int
  47 hdate_gdate_to_hdate (int d, int m, int y, int *hd, int *hm, int *hy);
  48
  49 /**
  50  @brief compute general date structure from hebrew date
  51
  52  @param d Day of month 1..31
  53  @param m Month 0..13 ,  if m or d is 0 return current date.
  54  @param y Year in 4 digits e.g. 5731
  55
  56  @attention no sanity cheak !!
  57  */
  58 int
  59 hdate_hdate_to_gdate (int d, int m, int y, int *gd, int *gm, int *gy);
  60
  61 /**
  62  @brief Compute Julian day (jd from Gregorian day, month and year (d, m, y)
  63  Algorithm from 'Julian and Gregorian Day Numbers' by Peter Meyer
  64  @author Yaacov Zamir ( algorithm from Henry F. Fliegel and Thomas C. Van Flandern ,1968)
  65
  66  @param d Day of month 1..31
  67  @param m Month 1..12
  68  @param y Year in 4 digits e.g. 2001
  69  */
  70 int
  71 hdate_gdate_to_jd (int d, int m, int y);
  72
  73 /**
  74  @brief Converting from the Julian day to the Gregorian day
  75  Algorithm from 'Julian and Gregorian Day Numbers' by Peter Meyer
  76  @author Yaacov Zamir ( Algorithm, Henry F. Fliegel and Thomas C. Van Flandern ,1968)
  77
  78  @param jd Julian day
  79  @param d Return Day of month 1..31
  80  @param m Return Month 1..12
  81  @param y Return Year in 4 digits e.g. 2001
  82  */
  83 void
  84 hdate_jd_to_gdate (int jd, int *d, int *m, int *y);
  85
  86 /**
  87  @brief Converting from the Julian day to the Hebrew day
  88  @author Amos Shapir 1984 (rev. 1985, 1992) Yaacov Zamir 2003-2005
  89
  90  @param jd Julian day
  91  @param d Return Day of month 1..31
  92  @param m Return Month 1..14
  93  @param y Return Year in 4 digits e.g. 2001
  94  */
  95 void
  96 hdate_jd_to_hdate (int jd, int *d, int *m, int *y);
  97
  98 /**
  99  @brief Compute Julian day (jd from Hebrew day, month and year (d, m, y)
 100  @author Amos Shapir 1984 (rev. 1985, 1992) Yaacov Zamir 2003-2005
 101
 102  @param d Day of month 1..31
 103  @param m Month 1..14
 104  @param y Year in 4 digits e.g. 5753
 105  */
 106 int
 107 hdate_hdate_to_jd (int d, int m, int y);
 108
 109 /* string functions */
 110
 111 /**
 112  @brief convert an integer to hebrew string UTF-8 (logical)
 113
 114  @param n The int to convert
 115  @attention ( 0 < n < 10000)
 116  @warning uses a static string, so output should be copied away.
 117 */
 118 void hdate_int_to_hebrew (GString *res, int n);
 119
 120 /**
 121  @brief Return a static string, with name of hebrew month.
 122
 123  @param month The number of the month 0..13 (0 - tishre, 12 - adar 1, 13 - adar 2).
 124  @warning uses a static string, so output should be copied away.
 125 */
 126 const char *hdate_get_hebrew_month_name (int month);
 127
 128 /**
 129  @brief Return a static string, with name of hebrew month in hebrew.
 130
 131  @param month The number of the month 0..13 (0 - tishre, 12 - adar 1, 13 - adar 2).
 132  @warning uses a static string, so output should be copied away.
 133 */
 134 const char *hdate_get_hebrew_month_name_heb (int month);
 135
 136 #ifdef __cplusplus
 137 }
 138 #endif
 139
 140 #endif