Kevin Day [Sun, 11 Dec 2022 03:58:49 +0000 (21:58 -0600)]
Feature: Add support for printing partial data with or without closing data in fss_write.
The "complete" "partial" FSS write enumaration settings still prints the end of Object or Content data.
This "partial" simply does not print the end of line characters.
Change the behavior to act like the newly added feature regarting "complete" "trim".
Provide parameters to toggle on printing of the closing data.
Kevin Day [Sun, 11 Dec 2022 00:00:03 +0000 (18:00 -0600)]
Update: Redesign project structure to follow the "main" design used in fss_write.
This makes the program structure more consistent.
The structure being followed easily allows for a more object-oriented directory structure and design.
This design is more accurately closer to "progam-oriented" than "object-oriented" due to the structure revolving around a program.
The design of the code itself in fss_write is object-oriented like.
Use this code design for fss_status_code and status_code.
The other programs do not need to do this and have everything under the "main".
Kevin Day [Sat, 10 Dec 2022 22:36:27 +0000 (16:36 -0600)]
Update: Centralize the error print function names.
This reduces repeated strings in the code.
A helper macro is used so that the individual code never needs to be changed if there are any changes to the array and the enumeration.
Kevin Day [Sat, 10 Dec 2022 17:28:35 +0000 (11:28 -0600)]
Update: Finish updating fss_write.
Remove the unused files.
Simplify the processing callbacks using ternary operators.
Resolve the void_setting to the specific setting for easier to read code at the cost of allocation more memory (1 memory address variable per function).
Implement the ignore functionality.
Make sure the multiple Content is supported where appropriate.
The flags must not be reset at the start of the setting load so that main.c programs can pre-fill the flags.
Add all of the supported write program setting files.
Other miscellaneous changes and fixes.
The pipe data is lacking and will need future reviews and probably will need fixes.
The original fss_*_write pipe data is also lacking so I feel that it is fine to leave it alone for now to be addressed later on.
Kevin Day [Sat, 10 Dec 2022 16:28:24 +0000 (10:28 -0600)]
Security: Invalid write in FSS functions and ensure a reset used length on error.
The command that triggers this is "fss_basic_write -oc hi there".
An invalid write is happening due to not always performing the array size increase operations.
Update all FSS write functions with more thorough checks.
This problem is being obfuscated by the lossy allocation.
When errors happen the destination->used needs to be consistently reset to the original value on return.
Use the lossy allocation as well for allocation shwere the increase by is a raw digit.
In these specific cases use state.step_small rather than state.step_large.
Rename used_start to destination_used for improved consistency.
Kevin Day [Fri, 9 Dec 2022 03:51:03 +0000 (21:51 -0600)]
Bugfix: Some of the level checking defines have an "s" that should not be there.
Fix incorrect _di_level_0_parameters_checking_, replacing it with _di_level_0_parameter_checking_.
Fix incorrect _di_level_2_parameters_checking_, replacing it with _di_level_2_parameter_checking_.
Kevin Day [Thu, 8 Dec 2022 06:09:56 +0000 (00:09 -0600)]
Update: More consistently follow the recent clarifications of the style guide for defines.
I discovered that the "_s" type of notation to be incredibly helpful while working on the stand alone projects.
I also noticed some inconsistency in the naming structure to some extent.
I updated and clarified the style guide and then updated the defines where needed.
This turned out to be more work than expect and has been rushed a little.
Look out for mistakes.
Kevin Day [Tue, 6 Dec 2022 03:59:24 +0000 (21:59 -0600)]
Update: Add support for backtick quoting for IKI.
Comply with the recent addition to the IKI specification that designates backticks as a quote alternative to single and double quotes.
Fix several inconsistencies observed, such as "quoted" vs "quote".
The code is inconsistently using a type code and a literal character for passing the desired quote.
This is probably a long lost incomplete refactor.
Change all of the FSS code to accept the character as a uint8_t.
Get rid of the f_fss_quote_t and related, replacing them with uint8_t.
Get rid of the f_fss_delimit_* macros.
These are redundant and it is simpler just to use the f_fss_* variants.
Rename F_fss_delimit_placeholder_s to F_string_placeholder_s (and similar).
The flags for single and double quotes are not needed when the charaacter is being explicitly set.
In the second case the line 0000000000000001 should not print the string '| ∩ |'.
This is happening because the character is not being properly reset in the situation where the overflow happens at the end of input.
With this change the results should now be:
# clear ; echo -n "xa" | byte_dump -wt 2 && echo -n "∩" | byte_dump -wt 2 && echo -n "∩xa" | byte_dump -wt 2
Piped Byte Dump: (in Hexidecimal) 0000000000000000 78 61 | x a |
Perform a trivial cleanup/optimization where inverse of bytes is being checked for.
This is pointless when there is an else block.
Reverse the order and remove the "not" operator.
Kevin Day [Mon, 5 Dec 2022 01:02:32 +0000 (19:02 -0600)]
Progress: Continue program related work, updating fss_write.
Rename F_supported to F_supported and F_supported_not to F_support_not to avoid past tense.
Add a static empty range to make initialization assignment even easier.
For fss_write:
- Add most of the ignore range handling.
- Add support for the multiple Content per Object and handle errors for standards that do not support this.
- Lost of clean up and simplifications.
- Add a lot of fixme and todo comments for things not yet completed.
There is still a lot to do with fss_write.
The common write functionality is mostly done.
The standard specific functionality is not written for anything except FSS Payload.
Kevin Day [Fri, 2 Dec 2022 04:29:36 +0000 (22:29 -0600)]
Progress: Continue program related work, updating fss_write.
Fix minor spacing problem where the color context should be closed near non-whitespace whenever possible.
Add missing word "error" in some comments.
Continue working in fss_write.
This gets the fss_payload_write program compiling.
The installer by default doesn't handle all of the programs.
Where before './install.sh -w /tmp/fll/' used to work now the following are all needed:
- ./install.sh -w /tmp/fll/
- ./install.sh -w /tmp/fll/ -s data/build/settings.main
- ./install.sh -w /tmp/fll/ -s data/build/settings.payload
Kevin Day [Tue, 29 Nov 2022 03:38:03 +0000 (21:38 -0600)]
Progress: Continue program related work, updating fss_write.
The work continues, focusing on preparing fss_write for handling all currently written fss_*_write programs.
This should also pave the way for supporting other fss-???? standards than are currently directly represented.
The individual write programs will be linked to the same library fss_write is.
These individual write programs will act as if they were passed the "--as XXXX".
For example, fss_basic_list would operate the same as "fss_write -a fss-0002".
Some of the programs may have vastly different functionality than others.
In any case that code can be shared that code will be shared.
Kevin Day [Fri, 25 Nov 2022 01:11:29 +0000 (19:11 -0600)]
Update: Fix and improve FSS unit test regarding zero-width.
Recent changes to the Unicode functions regarding zero-width improved or changed how what is designated as a zero-width character.
The test is failing due to this change.
Update the test to treat the tested character as zero-width.
Add an additional test condition to test the stop range.
Kevin Day [Wed, 23 Nov 2022 03:16:20 +0000 (21:16 -0600)]
Progress: Stub out the fss_write program.
The fss_write program is going to replace all of the other fss_X_write programs.
This is the initial setup and may not be the final structure.
I still have some fiddlign to do to figure out how I want them to share code.
The final result is intended to have the fss_write being capable of compiling all of the fss_X_write programs as well as the fss_write program.
Kevin Day [Wed, 23 Nov 2022 02:03:31 +0000 (20:03 -0600)]
Regression: Improper execution when no arguments and no pipe are passed to fake.
At some point in time the default for executing without a "clean", "make", or "build" stopped working.
This probably happened when I fixed the empty pipe bug.
Kevin Day [Wed, 23 Nov 2022 01:43:16 +0000 (19:43 -0600)]
Security: Invalid access when calling fake without 'make' or 'build'.
This is caused by the F_data_not return result not being processed in some of the fl_fss functions.
Additional changes:
- Make the return status constant.
- The status is being returned regardless in some cases so remove the effectively redundant lines of code.
- Combined the additional if condition blocks together.
Kevin Day [Tue, 22 Nov 2022 03:14:44 +0000 (21:14 -0600)]
Update: All projects should have fakefiles.
This is an oversight and neither a bug nor a feature.
The FLL is designed to be built using the build settings.
The flagship program fake, should still be directly supported and fakefiles should be available.
Most of these fakefiles just trigger the build settings.
Kevin Day [Thu, 17 Nov 2022 03:23:27 +0000 (21:23 -0600)]
Update: Finish program related work for fss_payload_write.
This appears to be done now.
The next step for fss_payload_write is to use it as the starting point for the fss_write program that is intended to provide all of the fss_*_write programs.
I will likely make improvements to the lazy approach I took regarding loading the entire file when processing.
I found two bugs regarding the pipe processing.
1) The first character never gets printed for payload Content.
2) An end-of-content character must be printed after the Content if printing partial Objects or if the "payload" Content is not yet printed.
Kevin Day [Fri, 11 Nov 2022 04:57:04 +0000 (22:57 -0600)]
Cleanup: Improve organization in f_utf, using addtional files.
Create more files to better organize structures and their accompanying functions.
Structures like f_utf_string_dynamic_t, f_utf_string_dynamics_t, and f_utf_string_dynamicss_t now each have their own files.
Kevin Day [Fri, 11 Nov 2022 03:25:05 +0000 (21:25 -0600)]
Cleanup: Improve organization in f_string, using addtional files.
Create more files to better organize structures and their accompanying functions.
Structures like f_string_dynamic_t, f_string_dynamics_t, and f_string_dynamicss_t now each have their own files.
Kevin Day [Tue, 8 Nov 2022 04:05:54 +0000 (22:05 -0600)]
Bugfix: Output stream is not properly unlocked on signal.
The output stream is locked during some loops.
When an appropriate signal is received while in one of these loops, the program exits.
The output stream must be unlocked before returning.
Kevin Day [Sun, 6 Nov 2022 22:03:36 +0000 (16:03 -0600)]
Feature: Add support for additional dependencies and settings files in level_3.
The package.sh build system helper script now supports additional dependencies and settings files.
This allows for special build modes, such as how the controller program has support for "controller" and "init" programs.
Kevin Day [Sat, 5 Nov 2022 01:24:38 +0000 (20:24 -0500)]
Bugfix: Incomplete UTF-8 zero-width detection, particularly for combining characters.
The zero-width calculations should be and are not including zero-width and most control characters.
The combining characters and most of the control characters are now considered zero-width.
Kevin Day [Sat, 29 Oct 2022 03:57:02 +0000 (22:57 -0500)]
Update: Slight improvement in UTF unassigned detection and add or correct some ranges.
Change "character" to "sequence" to be consistent with the rest of the private functions.
Add several additional checks to ideally reduce the number of checks.
This is only a cursory pass and not much effort is put into fine-tuned optimization.
There is huge room for improvement.
I discovered some ranges that needed to be added as unassined and added them.
Include the invalid ranges as unassigned.
Kevin Day [Sat, 29 Oct 2022 01:49:15 +0000 (20:49 -0500)]
Bugfix: Two 0's are printed when --total is used and there are no matching Objects.
There is an optimization used that immediately prints 0 and returns if there is no matching data on load.
The problem is that the caller isn't told that it should stop processing because F_none is returned.
Remove the optimization rather than implementing a custom return code and changing the code to handle this.
The normal code is still run and still correctly determines that there are 0 Objects.
Kevin Day [Fri, 28 Oct 2022 04:54:58 +0000 (23:54 -0500)]
Feature: Add support for ZSH in addition to BASH.
Some systems have started provided ZSH for license reasons (they don't want to agree to the license of BASH).
I experimented with and found that I can make my scripts ZSH friendly.
There is no way to "detect" that ZSH is being used as far as I can tell so I defined a new environment variable SHELL_ENGINE.
Set this to "zsh" and then run the script via the "zsh" program.
Enable emulation mode of "ksh" when using ZSH to be BASH friendly.
The ZSH doesn't support "${!i}" substitution.
I found a separate way to do this in ZSH via "${(P)i}".
It is a shame that they cannot simply replace "(P)" with "!".
There are several cases where "bash" is being directly called.
Replace this with a "shell_command" environment variable.
In some cases, directly calling "bash" may cause a loss of needed environment settings and so "bash" is not directly called when using BASH but "zsh" is still directly called when using ZSH.
The ZSH does not automatically handle arrays as well as BASH does.
Explicitly define arra with "-A" and explicitly set the initial value to "()".
Doing this may introduce problems with older versions of BASH that do not support "-A".
The ZSH cannot expand parameters as intelligently as BASH.
Parameters followed by certain characters, such as a bracket, that are not encases in braces result in ZSH errors.
Mass change many of the parameter uses to always be in braces.
Not all cases are changed and there may be some areas where I intended to make such a change and missed.
The ZSH appears not to handle output redirection from shell functions.
This behavior is used heavily in the project for building and using the variables array.
Change the behavior (at the cost of making the code a bit ugglier and harder to read in some cases) to assign a variable defined at a higher scope (such as "key").
The ZSH also appears to utilize "path" as a variable for "PATH" or is case insensitive when it comes to environment variables and shell variables.
This is a serious problem.
The variable "path" is defined so rename that to "path_" to avoid conflicts (and I'll just have to suffer cringing every time I see that trailing underscore).
I stumbled onto some bugs as well while making changes.
The necessary changes change the code that is buggy so I am allowing it to be in the same commit.
One of the bugs is a typo where errror is used rather than error.
Another bug is where the c_warning is used and then c_error is used within the same string (should be consistently using c_warning in this case).
It turns out "has-build_compiler" is not defined but conveniently a space for it is missing in bootstrap.sh (must be an accidental delete given the coincidence).
Some of the "mode" properties are incorrectly being assigned the non-mode value when a mode value exists in bootstrap.sh.
Kevin Day [Fri, 28 Oct 2022 01:07:00 +0000 (20:07 -0500)]
Cleanup: Rename and relocate private is_unassigned files.
The private-is_unassigned.c and private-is_unassigned.h are in incorrect locations and have incorrect names.
Relocate and rename to make these private files consistent with other private files.
Kevin Day [Fri, 28 Oct 2022 00:53:39 +0000 (19:53 -0500)]
Update: Support Unicode 15.0.
I couldn't easily find what Unicode version I am trying to suppot so I added a unicode.txt document.
The initial work was done for Unicode 12.1 and later switched to 14.0.
I was still in the initial stages of learning Unicode and so I expect there to be notable incompleteness or incorrectness.
With the release of Unicode 15.0 I am able to determine a distinct set of changes and I have applied the changes.
Add a private_inline_f_utf_character_handle_digit_offset() inline function to simplify some of the redundant code.
Kevin Day [Sun, 23 Oct 2022 21:31:53 +0000 (16:31 -0500)]
Progress: The iki_read should also support the previous "--substitute" behavior via "--reassign".
A "--substitute" bug is now fixed where the "--wrap" is applied.
It seems to me that the old behavior of "--substitute" should still exist.
Introduce a new parameter called "--reassign" that provides the old substitute behavior.
Kevin Day [Sun, 23 Oct 2022 02:58:16 +0000 (21:58 -0500)]
Progress: Fix problems in iki_read.
As I suspected, the interruptions resulted in incomplete and problematic code.
Fix copy and paste problems where modulus should instead be a slash (divide).
Use _increase_by functions rather than _resize functions to be more memory recycling friendly.
When processing parameters the index relative to the argv should be used.
Change the logic in the loops to increment "i" across all parameter values rather than the total sets.
Fix copy and paste mistakes where "wrap" is being incremented for non-wrap data.
The "--whole" parameter is not being processed and having the appropriate flag set.
The print function has incorrect ordering and structure of some of the functions called.
The print function is further simplified now that settings is passing the flag along.
The "wrap" append functions are not comparing against the correct variable (I swapped them by accident).
Do not do "register" types of optimizations at this point in time (this can be done far in the future when things are stable-ish).
Be sure to clear the lengths using memset().
The variable "k" can be moved inside the if condition following its assignment.
Kevin Day [Sat, 22 Oct 2022 14:50:44 +0000 (09:50 -0500)]
Refactor: Change FILE * to f_file_t when printing.
Due to the by-design restrictions, the f_file_t cannot be defined in f_file project and be used in another level_0 project.
The f_print project cannot depend on f_file project and cannot use f_file_t.
I spent some time considering this problem.
The f_type project is a special case core project that othe level_0 projects can depend on it.
This project also provides types and f_file_t is a type.
Move f_file_t's definition into f_file project.
I want to avoid always pulling in file related headers.
The the f_file_t is defined in a separate file "type_file.h".
The "type_file.h" must be manually included when needed.
With type_file.h in place, the print projects all include "type_file.h" and utilize f_file_t.
The "FILE *" stream is now replaced wth f_file_t.
This simplifies the code, makes it easier to use, and makes it easier to maintain.
For example, "fll_print_dynamic_raw(f_string_eol_s, main->output.to.stream);" can not be "fll_print_dynamic_raw(f_string_eol_s, main->output.to);".
I made this decision in the middle of a "Progress" change process.
There may be code missed and tests may need to be updated at some point after the "Progress" change process is complete.
Kevin Day [Fri, 21 Oct 2022 03:23:46 +0000 (22:23 -0500)]
Progress: Continue program related work.
There has been a lot of interruptions with this particular pass.
Additional review is recommended.
I specifically need to review the iki_read for all of the parameters and make sure that there are no regressions.
Simplify the code, replacing f_iki_content_t, f_iki_delimits_t, and similar with direct types such as f_string_ranges_t and f_array_lengths_t.
This reduces some of the flexibility but increases the maintainability.
Make some of the print error functions accepts the symbols for both the first and second parameters.
Add additional error print functions.
Fix problem with --help printing.
Comment consistency improvements.
The iki_read program is updated to follow the design changes regarding programs.
Kevin Day [Tue, 13 Sep 2022 01:00:11 +0000 (20:00 -0500)]
Progress: Continue program related work.
Add more common program print functions.
The parameter missing function is ironically missing the print messages.
I've decided to accept the loss of binary size for improved runtime efficiency (both of which are likely slight losses and improvements).
There are now "unlocked" and "locked" print line first and print line last functions for each program.
The boolean for designating lock is removed.
These functions are mostly wrappers and so the cost in size to be hopefully negligible.
I imagine time will tell whether this is an overall good or a bad decision.
Kevin Day [Mon, 5 Sep 2022 22:44:28 +0000 (17:44 -0500)]
Update: Add support for stand_alone builds in the example bootstrap script.
The bootstrap-example.sh script now supports building in "stand alone" mode for any program that has the mode defined.
The currently supported programs "fake" and "utf8" are still hard coded.
Future versions may check for the existence of the named files rather than being hard coded.
Update utf8 to compile.
Make the same changes for fake, but fake is not yet read because it has not been migrated yet.
I forgot to update the new "stand alone" build settings with the new private source file.
The tests now use this "stand alone" build for building fake and using that fake to perform the tests.
Fix a problem with existing code that has incorrect macros.
Kevin Day [Thu, 1 Sep 2022 02:19:05 +0000 (21:19 -0500)]
Progress: Continue program related work.
Slight restructuring of memory allocation:
- Add or move double free and and unnecessary free checks.
- If amount 0 for increase functions, then do nothing.
- When resizing, perform a stale check in case strings point to a static string.
- The private_f_memory_structure_resize() should properly return the error response.
The fll_program_standard_set_down() needs to check both the stream and the descriptors when closing rather than one or the other.
Explicitly set signal_received to uint32_t rather than int.
- The signal needs to also be uint32_t rather than f_status_t.
Add several new print functions for common print messages used by the programs.
Switch from flockfile() to f_file_stream_lock() and from funlockfile() to f_file_stream_unlock().
- There are still a lot more cases where these changes need to be made.
Add more function documentation.
Use "greater than" rather than "not equal to" for console verbosity checks.
More changes to these programs:
- fss_status_code
- iki_write
- status_code
- utf8
Kevin Day [Mon, 22 Aug 2022 02:22:38 +0000 (21:22 -0500)]
Progress: Working on program related changes and fix version number.
Continuing work in regards to making program related changes.
I managed to miss another set of files that have version numbers.
I should probably write a script to consistently handle this in the future to avoid these kinds of simple mistakes.
Change the behavior of the color loaded to allow for more flexibility.
The previous design was a quickly put togethor hardcoded approach.
I want to get away from such practices.
Add missing dependency in f_color.
I am at a cross roads of flexibility and maintainability (as well as size).
The practice of always having and using a typedef allows for great flexibility (allows for easy hacking/modifications).
As per my practice, I should have explicit functions for allocating, deallocating, and similar functions.
These waste space, consume time writing, and consume maintainance related time.
I want to increase the maintainability of the project given that my current goals are far reaching.
This means that I should switch to existing typedefs for any simple data type (except for special cases like strings and f_string_t).
I am starting this conversion with f_color, using the uintX_t types rathe than custom types like f_color_mode_t.
Start using enumerations over define macros.
Make the console parameter processing functions more flexible by returning the decision at the index rather than the converted decision value.
This allows for the caller to know which index is used.
The caller can do more work based on this without having to do more looping.
Add line_first_no and line_last_no standard parameters.
These add more flexibility for special case scripting.
Many core printing functions now do not print the leading new line.
All programs must be updated accordingly.
Add and document new console parameter initialization macros.
Start a new style practice with the console arguments, based around these new macros.
The f_file_stream_flush() should not need f_file_t parameter to be a pointer.
The memory functions now return F_data_not in more situations that make sense.
When size is 0 for allocation functions, this should be a paameter error when doing parameter checking.
The pointer should be allowed to be NULL when allocating.
Some fll_program functions are supposed to be using private functions due to internal usage.
The standard help options now have a standard printing function.
The fll_program_parameter_process() is removed.
Instead, call f_console_parameter_process directly.
The color context handling is moved from the now deleted fll_program_parameter_process() into fll_program_parameter_process_context().
The fll_program_data_t now accepts a pointer to the environment variable array for representing the environment variables are start.
The fll_program_data_t now uses flags rather than a boolean to represent program pipe (allowing for more than just input pipe, in theory).
Add new status codes:
- F_help
- F_help_not
Major work is completed into making the utf8 program more flexible.
- Moved all parameter processing into utf8_setting_load() and provide utf8_setting_t.
- This allows for callers to manually configure the settings without performing parameter processing if so desired.
- Re-design printing logic to handle the line_first_no and line_last_no parameters.
- The status used by the utf8_main() is now in utf8_setting_t.
Related changes have been lazily applied to all other programs.
Once I am finished with utf8 (which I might already be), then I will beging moving to each next program.