Browse Source

Renamed Weekday & Month functions & underscored variables

It's better this way imo
thareh 2 years ago
parent
commit
7caea2633f

+ 86 - 86
datetime.mod/datetime.bmx

@@ -111,20 +111,20 @@ Type TDate
 	</pre>
 	<a href="../examples/tdate_create.bmx">Example source</a>
 	End Rem
-	Method New(year:Int, _month:Int, day:Int)
-		New (bmx_datetime_newdate(year, _month, day))
+	Method New(year:Int, month:Int, day:Int)
+		New (bmx_datetime_newdate(year, month, day))
 	End Method
 	
-	Method New(year:Int, _month:EMonth, day:Int)
-		New (bmx_datetime_newdate(year, Int(_month), day))
+	Method New(year:Int, month:EMonth, day:Int)
+		New (bmx_datetime_newdate(year, Int(month), day))
 	End Method
 	
-	Method New(year:Int, _month:EMonth, day:ENthDay)
-		New (bmx_datetime_newdate(year, Int(_month), Int(day)))
+	Method New(year:Int, month:EMonth, day:ENthDay)
+		New (bmx_datetime_newdate(year, Int(month), Int(day)))
 	End Method
 	
-	Method New(year:Int, _month:Int, day:ENthDay)
-		New (bmx_datetime_newdate(year, _month, Int(day)))
+	Method New(year:Int, month:Int, day:ENthDay)
+		New (bmx_datetime_newdate(year, month, Int(day)))
 	End Method
 	
 	Rem
@@ -303,8 +303,8 @@ Type TDate
 	</pre>
 	<a href="../examples/tdate_ymd.bmx">Example source</a>
 	End Rem
-	Method ymd(year:Int Var, _month:Int Var, day:Int Var)
-		bmx_datetime_ymd(datePtr, Varptr year, Varptr _month, Varptr day)
+	Method ymd(year:Int Var, month:Int Var, day:Int Var)
+		bmx_datetime_ymd(datePtr, Varptr year, Varptr month, Varptr day)
 	End Method
 	
 	Rem
@@ -1077,8 +1077,8 @@ Type TDateIterator Extends TDate Abstract
 		Return bmx_datetime_iter_day(datePtr)
 	End Method
 	
-	Method ymd(year:Int Var, _month:Int Var, day:Int Var)
-		bmx_datetime_iter_ymd(datePtr,Varptr year,Varptr _month,Varptr day)
+	Method ymd(year:Int Var, month:Int Var, day:Int Var)
+		bmx_datetime_iter_ymd(datePtr,Varptr year,Varptr month,Varptr day)
 	End Method
 	
 	Method dayOfWeek:Int()
@@ -2641,20 +2641,20 @@ Type TPartialDate Extends TYearBasedGenerator
 	Rem
 	bbdoc: Creates a new #TPartialDate for the given day and month.
 	End Rem
-	Method New(day:Int, _month:Int)
-		ybgPtr = bmx_partial_date_new(day, _month)
+	Method New(day:Int, month:Int)
+		ybgPtr = bmx_partial_date_new(day, month)
 	End Method
 	
-	Method New(day:ENthDay, _month:Int)
-		ybgPtr = bmx_partial_date_new(Int(day), _month)
+	Method New(day:ENthDay, month:Int)
+		ybgPtr = bmx_partial_date_new(Int(day), month)
 	End Method
 	
-	Method New(day:ENthDay, _month:EMonth)
-		ybgPtr = bmx_partial_date_new(Int(day), Int(_month))
+	Method New(day:ENthDay, month:EMonth)
+		ybgPtr = bmx_partial_date_new(Int(day), Int(month))
 	End Method
 	
-	Method New(day:Int, _month:EMonth)
-		ybgPtr = bmx_partial_date_new(day, Int(_month))
+	Method New(day:Int, month:EMonth)
+		ybgPtr = bmx_partial_date_new(day, Int(month))
 	End Method
 
 	Method getDate:TDate(year:Int)
@@ -2688,20 +2688,20 @@ Type TLastDayOfWeekInMonth Extends TYearBasedGenerator
 	Month may be one of #EMonth.January, #EMonth.February, #EMonth.March, #EMonth.April, #EMonth.May, #EMonth.June, #EMonth.July,
 	#EMonth.August, #EMonth.September, #EMonth.October, #EMonth.November or #EMonth.December.
 	End Rem
-	Method New(_weekday:Int, _month:Int)
-		ybgPtr = bmx_last_day_of_week_in_month_new(_weekday, _month)
+	Method New(weekday:Int, month:Int)
+		ybgPtr = bmx_last_day_of_week_in_month_new(weekday, month)
 	End Method
 	
-	Method New(_weekday:EWeekday, _month:Int)
-		ybgPtr = bmx_last_day_of_week_in_month_new(Int(_weekday), _month)
+	Method New(weekday:EWeekday, month:Int)
+		ybgPtr = bmx_last_day_of_week_in_month_new(Int(weekday), month)
 	End Method
 	
-	Method New(_weekday:EWeekday, _month:EMonth)
-		ybgPtr = bmx_last_day_of_week_in_month_new(Int(_weekday), Int(_month))
+	Method New(weekday:EWeekday, month:EMonth)
+		ybgPtr = bmx_last_day_of_week_in_month_new(Int(weekday), Int(month))
 	End Method
 	
-	Method New(_weekday:Int, _month:EMonth)
-		ybgPtr = bmx_last_day_of_week_in_month_new(_weekday, Int(_month))
+	Method New(weekday:Int, month:EMonth)
+		ybgPtr = bmx_last_day_of_week_in_month_new(weekday, Int(month))
 	End Method
 
 	Method getDate:TDate(year:Int)
@@ -2735,20 +2735,20 @@ Type TFirstDayOfWeekInMonth Extends TYearBasedGenerator
 	Month may be one of #EMonth.January, #EMonth.February, #EMonth.March, #EMonth.April, #EMonth.May, #EMonth.June, #EMonth.July,
 	#EMonth.August, #EMonth.September, #EMonth.October, #EMonth.November or #EMonth.December.
 	End Rem
-	Method New(_weekday:Int, _month:Int)
-		ybgPtr = bmx_first_day_of_week_in_month_new(_weekday, _month)
+	Method New(weekday:Int, month:Int)
+		ybgPtr = bmx_first_day_of_week_in_month_new(weekday, month)
 	End Method
 	
-	Method New(_weekday:EWeekday, _month:Int)
-		ybgPtr = bmx_first_day_of_week_in_month_new(Int(_weekday), _month)
+	Method New(weekday:EWeekday, month:Int)
+		ybgPtr = bmx_first_day_of_week_in_month_new(Int(weekday), month)
 	End Method
 	
-	Method New(_weekday:EWeekday, _month:EMonth)
-		ybgPtr = bmx_first_day_of_week_in_month_new(Int(_weekday), Int(_month))
+	Method New(weekday:EWeekday, month:EMonth)
+		ybgPtr = bmx_first_day_of_week_in_month_new(Int(weekday), Int(month))
 	End Method
 	
-	Method New(_weekday:Int, _month:EMonth)
-		ybgPtr = bmx_first_day_of_week_in_month_new(_weekday, Int(_month))
+	Method New(weekday:Int, month:EMonth)
+		ybgPtr = bmx_first_day_of_week_in_month_new(weekday, Int(month))
 	End Method
 
 	Method getDate:TDate(year:Int)
@@ -2785,32 +2785,32 @@ Type TNthDayOfWeekInMonth Extends TYearBasedGenerator
 	Month may be one of #EMonth.January, #EMonth.February, #EMonth.March, #EMonth.April, #EMonth.May, #EMonth.June, #EMonth.July,
 	#EMonth.August, #EMonth.September, #EMonth.October, #EMonth.November or #EMonth.December (1-12).
 	End Rem
-	Method New(nth:Int, _weekday:Int, _month:Int)
-		ybgPtr = bmx_nth_day_of_week_in_month_new(nth, _weekday, _month)
+	Method New(nth:Int, weekday:Int, month:Int)
+		ybgPtr = bmx_nth_day_of_week_in_month_new(nth, weekday, month)
 	End Method
 	
-	Method New(nth:ENthDay, _weekday:Int, _month:Int)
-		ybgPtr = bmx_nth_day_of_week_in_month_new(Int(nth), _weekday, _month)
+	Method New(nth:ENthDay, weekday:Int, month:Int)
+		ybgPtr = bmx_nth_day_of_week_in_month_new(Int(nth), weekday, month)
 	End Method
 	
-	Method New(nth:ENthDay, _weekday:EWeekday, _month:Int)
-		ybgPtr = bmx_nth_day_of_week_in_month_new(Int(nth), Int(_weekday), _month)
+	Method New(nth:ENthDay, weekday:EWeekday, month:Int)
+		ybgPtr = bmx_nth_day_of_week_in_month_new(Int(nth), Int(weekday), month)
 	End Method
 	
-	Method New(nth:ENthDay, _weekday:EWeekday, _month:EMonth)
-		ybgPtr = bmx_nth_day_of_week_in_month_new(Int(nth), Int(_weekday), Int(_month))
+	Method New(nth:ENthDay, weekday:EWeekday, month:EMonth)
+		ybgPtr = bmx_nth_day_of_week_in_month_new(Int(nth), Int(weekday), Int(month))
 	End Method
 	
-	Method New(nth:Int, _weekday:EWeekday, _month:EMonth)
-		ybgPtr = bmx_nth_day_of_week_in_month_new(nth, Int(_weekday), Int(_month))
+	Method New(nth:Int, weekday:EWeekday, month:EMonth)
+		ybgPtr = bmx_nth_day_of_week_in_month_new(nth, Int(weekday), Int(month))
 	End Method
 	
-	Method New(nth:Int, _weekday:Int, _month:EMonth)
-		ybgPtr = bmx_nth_day_of_week_in_month_new(nth, _weekday, Int(_month))
+	Method New(nth:Int, weekday:Int, month:EMonth)
+		ybgPtr = bmx_nth_day_of_week_in_month_new(nth, weekday, Int(month))
 	End Method
 	
-	Method New(nth:Int, _weekday:EWeekday, _month:Int)
-		ybgPtr = bmx_nth_day_of_week_in_month_new(nth, Int(_weekday), _month)
+	Method New(nth:Int, weekday:EWeekday, month:Int)
+		ybgPtr = bmx_nth_day_of_week_in_month_new(nth, Int(weekday), month)
 	End Method
 
 	Method getDate:TDate(year:Int)
@@ -2845,12 +2845,12 @@ Type TFirstDayOfWeekAfter
 	about: A weekday may be one of #EWeekday.Sunday, #EWeekday.Monday, #EWeekday.Tuesday, #EWeekday.Wednesday, #EWeekday.Thursday,
 	#EWeekday.Friday or #EWeekday.Saturday (0-6).
 	End Rem
-	Method New(_weekday:Int)
-		ybgPtr = bmx_first_day_of_week_after_new(_weekday)
+	Method New(weekday:Int)
+		ybgPtr = bmx_first_day_of_week_after_new(weekday)
 	End Method
 	
-	Method New(_weekday:EWeekday)
-		ybgPtr = bmx_first_day_of_week_after_new(Int(_weekday))
+	Method New(weekday:EWeekday)
+		ybgPtr = bmx_first_day_of_week_after_new(Int(weekday))
 	End Method
 
 	Rem
@@ -2887,12 +2887,12 @@ Type TFirstDayOfWeekBefore
 	about: A weekday may be one of #EWeekday.Sunday, #EWeekday.Monday, #EWeekday.Tuesday, #EWeekday.Wednesday, #EWeekday.Thursday,
 	#EWeekday.Friday or #EWeekday.Saturday (0-6).
 	End Rem
-	Method New(_weekday:Int)
-		ybgPtr = bmx_first_day_of_week_before_new(_weekday)
+	Method New(weekday:Int)
+		ybgPtr = bmx_first_day_of_week_before_new(weekday)
 	End Method
 	
-	Method New(_weekday:EWeekday)
-		ybgPtr = bmx_first_day_of_week_before_new(Int(_weekday))
+	Method New(weekday:EWeekday)
+		ybgPtr = bmx_first_day_of_week_before_new(Int(weekday))
 	End Method
 
 	Rem
@@ -3169,24 +3169,24 @@ about: This is based on the current weekday format as specified by #TDateFacet.<
 Valid weekdays include #EWeekday.Sunday, #EWeekday.Monday, #EWeekday.Tuesday, #EWeekday.Wednesday, #EWeekday.Thursday,
 #EWeekday.Friday, #EWeekday.Saturday (0-6).
 End Rem
-Function WeekDay:String(_weekday:Int)
-	Return bmx_weekday_to_string(_weekday)
+Function WeekkdayName:String(weekday:Int)
+	Return bmx_weekday_to_string(weekday)
 End Function
 
-Function WeekDay:String(_weekday:EWeekday)
-	Return bmx_weekday_to_string(Int(_weekday))
+Function WeekkdayName:String(weekday:EWeekday)
+	Return bmx_weekday_to_string(Int(weekday))
 EndFunction
 
 Rem
 bbdoc: Get the month text for the specified @month (1 - 12).
 about: This is based on the current month format as specified by #TDateFacet.
 End Rem
-Function Month:String(_month:Int)
-	Return bmx_month_to_string(_month)
+Function MonthName:String(month:Int)
+	Return bmx_month_to_string(month)
 End Function
 
-Function Month:String(_month:EMonth)
-	Return bmx_month_to_string(Int(_month))
+Function MonthName:String(month:EMonth)
+	Return bmx_month_to_string(Int(month))
 End Function
 
 Rem
@@ -3194,12 +3194,12 @@ bbdoc: Calculates the number of days from given date until given @weekday.
 about: Valid weekdays include #EWeekday.Sunday, #EWeekday.Monday, #EWeekday.Tuesday, #EWeekday.Wednesday, #EWeekday.Thursday,
 #EWeekday.Friday, #EWeekday.Saturday (0-6).
 End Rem
-Function DaysUntilWeekday:Int(date:TDate, _weekday:Int)
-	Return bmx_days_until_weekday(date.datePtr, _weekday)
+Function DaysUntilWeekday:Int(date:TDate, weekday:Int)
+	Return bmx_days_until_weekday(date.datePtr, weekday)
 End Function
 
-Function DaysUntilWeekday:Int(date:TDate, _weekday:EWeekday)
-	Return bmx_days_until_weekday(date.datePtr, Int(_weekday))
+Function DaysUntilWeekday:Int(date:TDate, weekday:EWeekday)
+	Return bmx_days_until_weekday(date.datePtr, Int(weekday))
 End Function
 
 Rem
@@ -3207,12 +3207,12 @@ bbdoc: Calculates the number of day from given date to previous given @weekday.
 about: Valid weekdays include #EWeekday.Sunday, #EWeekday.Monday, #EWeekday.Tuesday, #EWeekday.Wednesday, #EWeekday.Thursday,
 #EWeekday.Friday, #EWeekday.Saturday (0-6).
 End Rem
-Function DaysBeforeWeekday:Int(date:TDate, _weekday:Int)
-	Return bmx_days_before_weekday(date.datePtr, _weekday)
+Function DaysBeforeWeekday:Int(date:TDate, weekday:Int)
+	Return bmx_days_before_weekday(date.datePtr, weekday)
 End Function
 
-Function DaysBeforeWeekday:Int(date:TDate, _weekday:EWeekday)
-	Return bmx_days_before_weekday(date.datePtr, Int(_weekday))
+Function DaysBeforeWeekday:Int(date:TDate, weekday:EWeekday)
+	Return bmx_days_before_weekday(date.datePtr, Int(weekday))
 End Function
 
 Rem
@@ -3220,12 +3220,12 @@ bbdoc: Generates a #TDate object representing the date of the following @weekday
 about: Valid weekdays include #EWeekday.Sunday, #EWeekday.Monday, #EWeekday.Tuesday, #EWeekday.Wednesday, #EWeekday.Thursday,
 #EWeekday.Friday, #EWeekday.Saturday (0-6).
 End Rem
-Function NextWeekday:TDate(date:TDate, _weekday:Int)
-	Return New TDate(bmx_next_weekday(date.datePtr, _weekday))
+Function NextWeekday:TDate(date:TDate, weekday:Int)
+	Return New TDate(bmx_next_weekday(date.datePtr, weekday))
 End Function
 
-Function NextWeekday:TDate(date:TDate, _weekday:EWeekday)
-	Return New TDate(bmx_next_weekday(date.datePtr, Int(_weekday)))
+Function NextWeekday:TDate(date:TDate, weekday:EWeekday)
+	Return New TDate(bmx_next_weekday(date.datePtr, Int(weekday)))
 End Function
 
 Rem
@@ -3233,23 +3233,23 @@ bbdoc: Generates a #TDate object representing the date of the previous @weekday
 about: Valid weekdays include #EWeekday.Sunday, #EWeekday.Monday, #EWeekday.Tuesday, #EWeekday.Wednesday, #EWeekday.Thursday,
 #EWeekday.Friday, #EWeekday.Saturday (0-6).
 End Rem
-Function PreviousWeekday:TDate(date:TDate, _weekday:Int)
-	Return New TDate(bmx_previous_weekday(date.datePtr, _weekday))
+Function PreviousWeekday:TDate(date:TDate, weekday:Int)
+	Return New TDate(bmx_previous_weekday(date.datePtr, weekday))
 End Function
 
-Function PreviousWeekday:TDate(date:TDate, _weekday:EWeekday)
-	Return New TDate(bmx_previous_weekday(date.datePtr, Int(_weekday)))
+Function PreviousWeekday:TDate(date:TDate, weekday:EWeekday)
+	Return New TDate(bmx_previous_weekday(date.datePtr, Int(weekday)))
 End Function
 
 Rem
 bbdoc: 
 End Rem
-Function EndOfMonthDay:Int(year:Int, _month:Int)
-	Return bmx_end_of_month_day(year, _month)
+Function EndOfMonthDay:Int(year:Int, month:Int)
+	Return bmx_end_of_month_day(year, month)
 End Function
 
-Function EndOfMonthDay:Int(year:Int, _month:EMonth)
-	Return bmx_end_of_month_day(year, Int(_month))
+Function EndOfMonthDay:Int(year:Int, month:EMonth)
+	Return bmx_end_of_month_day(year, Int(month))
 End Function
 
 Rem

+ 1 - 1
datetime.mod/examples/holidays.bmx

@@ -63,6 +63,6 @@ Print "~nNumber Holidays: " + allHolidays.count()
 
 
 Function printDate(date:TDate)
-	Print date.toString() + " [" + WeekDay(date.dayOfWeek()) + "]"
+	Print date.toString() + " [" + WeekdayName(date.dayOfWeek()) + "]"
 End Function
 

+ 1 - 1
datetime.mod/examples/print_month.bmx

@@ -21,7 +21,7 @@ Local ditr:TDateDayIterator = New TDateDayIterator(New TDate(y, m, 1))
 ' loop thru the days and print each one
 While Not ditr.isAfter(endOfMonth)
 
-	Print ditr.toString() + " [" + WeekDay(ditr.dayOfWeek()) + "]"
+	Print ditr.toString() + " [" + WeekdayName(ditr.dayOfWeek()) + "]"
 	
 	ditr.forward()