diff --git a/4coder_default_bindings.cpp b/4coder_default_bindings.cpp index 4f6cbc22..2a082ff6 100644 --- a/4coder_default_bindings.cpp +++ b/4coder_default_bindings.cpp @@ -237,6 +237,7 @@ OPEN_FILE_HOOK_SIG(my_file_settings){ } buffer_set_setting(app, &buffer, BufferSetting_WrapPosition, default_wrap_width); + buffer_set_setting(app, &buffer, BufferSetting_MinimumBaseWrapPosition, default_min_base_width); buffer_set_setting(app, &buffer, BufferSetting_MapID, (treat_as_code)?((int32_t)my_code_map):((int32_t)mapid_file)); if (treat_as_code && enable_code_wrapping && buffer.size < (1 << 18)){ diff --git a/4coder_default_include.cpp b/4coder_default_include.cpp index b3777521..2e5074e8 100644 --- a/4coder_default_include.cpp +++ b/4coder_default_include.cpp @@ -810,8 +810,11 @@ CUSTOM_COMMAND_SIG(left_adjust_view){ GUI_Scroll_Vars scroll = view.scroll_vars; - float x = get_view_x(view); - x = x - 30.f; + float x = get_view_x(view) - 30.f; + if (x < 0){ + x = 0.f; + } + scroll.target_x = (int32_t)(x + .5f); view_set_scroll(app, &view, scroll); } @@ -3133,14 +3136,7 @@ get_build_directory(Application_Links *app, Buffer_Summary *buffer, String *dir_ // TODO(allen): Better names for the "standard build search" family. static int32_t -standard_build_search(Application_Links *app, - View_Summary *view, - Buffer_Summary *active_buffer, - String *dir, String *command, - int32_t perform_backup, - int32_t use_path_in_command, - String filename, - String commandname){ +standard_build_search(Application_Links *app, View_Summary *view, Buffer_Summary *active_buffer, String *dir, String *command, int32_t perform_backup, int32_t use_path_in_command, String filename, String commandname){ int32_t result = false; for(;;){ @@ -3489,10 +3485,11 @@ COMMAND_CALLER_HOOK(default_command_caller){ return(0); } -// NOTE(allen|a4.0.12): A primordial config system (actually really hate this but it seems best) +// NOTE(allen|a4.0.12): A primordial config system (actually really hate this but it seems best at least right now... arg) static bool32 enable_code_wrapping = 1; static int32_t default_wrap_width = 672; +static int32_t default_min_base_width = 550; #include @@ -3558,6 +3555,13 @@ process_config_file(Application_Links *app){ default_wrap_width = str_to_int(val); } } + else if (match(id, "default_min_base_width")){ + if (val_token.type == CPP_TOKEN_INTEGER_CONSTANT){ + String val = make_string(mem + val_token.start, val_token.size); + default_min_base_width = str_to_int(val); + } + } + } } } diff --git a/4coder_jump_parsing.cpp b/4coder_jump_parsing.cpp index fa5dfb1c..7f092b7b 100644 --- a/4coder_jump_parsing.cpp +++ b/4coder_jump_parsing.cpp @@ -113,7 +113,7 @@ parse_jump_location(String line, Name_Based_Jump_Location *location, int32_t colon_pos2 = find_s_char(line, colon_pos1+1, ':'); int32_t colon_pos3 = find_s_char(line, colon_pos2+1, ':'); - if (colon_pos3+1 < line.size && line.str[colon_pos3+1] == ' '){ + if (colon_pos3+1 <= line.size){ String filename = substr(line, 0, colon_pos1); String line_number = substr(line, colon_pos1+1, colon_pos2 - colon_pos1 - 1); String column_number = substr(line, colon_pos2+1, colon_pos3 - colon_pos2 - 1); @@ -129,16 +129,7 @@ parse_jump_location(String line, Name_Based_Jump_Location *location, } } else{ - colon_pos1 = find_s_char(line, 0, ':'); - if (line.size > colon_pos1+1){ - if (char_is_slash(line.str[colon_pos1+1])){ - colon_pos1 = find_s_char(line, colon_pos1+1, ':'); - } - } - - colon_pos2 = find_s_char(line, colon_pos1+1, ':'); - - if (colon_pos2+1 < line.size && line.str[colon_pos2+1] == ' '){ + if (colon_pos2+1 <= line.size){ String filename = substr(line, 0, colon_pos1); String line_number = substr(line, colon_pos1+1, colon_pos2 - colon_pos1 - 1); diff --git a/4coder_version.h b/4coder_version.h index 7c070d84..582337ca 100644 --- a/4coder_version.h +++ b/4coder_version.h @@ -1,6 +1,6 @@ #define MAJOR 4 #define MINOR 0 -#define PATCH 12 +#define PATCH 13 #define VN__(a,b,c) #a"."#b"."#c #define VN_(a,b,c) VN__(a,b,c) diff --git a/4ed_api_implementation.cpp b/4ed_api_implementation.cpp index 1ad8db02..63c365ca 100644 --- a/4ed_api_implementation.cpp +++ b/4ed_api_implementation.cpp @@ -4,6 +4,8 @@ The implementation for the custom API // TOP +#define API_EXPORT + inline b32 access_test(u32 lock_flags, u32 access_flags){ b32 result = 0; @@ -153,15 +155,12 @@ imp_get_view(Command_Data *cmd, View_Summary *view){ return(vptr); } -#define API_EXPORT - API_EXPORT bool32 Exec_Command(Application_Links *app, Command_ID command_id) /* DOC_PARAM(command_id, The command_id parameter specifies which internal command to execute.) DOC_RETURN(This call returns non-zero if command_id named a valid internal command.) -DOC(A call to exec_command executes an internal command. -If command_id is invalid a warning is posted to *messages*.) +DOC(A call to exec_command executes an internal command. If command_id is invalid a warning is posted to *messages*.) DOC_SEE(Command_ID) */{ bool32 result = false; @@ -719,17 +718,20 @@ DOC_RETURN(returns non-zero on success) Command_Data *cmd = (Command_Data*)app->cmd_context; Editing_File *file = imp_get_file(cmd, buffer); int32_t result = 0; - + if (file){ + result = 1; switch (setting){ - case BufferSetting_Lex: result = file->settings.tokens_exist; break; - case BufferSetting_WrapLine: result = !file->settings.unwrapped_lines; break; - case BufferSetting_WrapPosition: result = file->settings.display_width; break; - case BufferSetting_MapID: result = file->settings.base_map_id; break; - case BufferSetting_Eol: result = file->settings.dos_write_mode; break; - case BufferSetting_Unimportant: result = file->settings.unimportant; break; - case BufferSetting_ReadOnly: result = file->settings.read_only; break; - case BufferSetting_VirtualWhitespace: result = file->settings.virtual_white; break; + case BufferSetting_Lex: *value_out = file->settings.tokens_exist; break; + case BufferSetting_WrapLine: *value_out = !file->settings.unwrapped_lines; break; + case BufferSetting_WrapPosition: *value_out = file->settings.display_width; break; + case BufferSetting_MinimumBaseWrapPosition: *value_out = file->settings.minimum_base_display_width; break; + case BufferSetting_MapID: *value_out = file->settings.base_map_id; break; + case BufferSetting_Eol: *value_out = file->settings.dos_write_mode; break; + case BufferSetting_Unimportant: *value_out = file->settings.unimportant; break; + case BufferSetting_ReadOnly: *value_out = file->settings.read_only; break; + case BufferSetting_VirtualWhitespace: *value_out = file->settings.virtual_white; break; + default: result = 0; break; } } @@ -1542,12 +1544,14 @@ DOC_RETURN(returns non-zero on success) */{ Command_Data *cmd = (Command_Data*)app->cmd_context; View *vptr = imp_get_view(cmd, view); - int32_t result = -1; + int32_t result = 0; if (vptr){ + result = 1; switch (setting){ - case ViewSetting_ShowWhitespace: result = vptr->file_data.show_whitespace; break; - case ViewSetting_ShowScrollbar: result = !vptr->hide_scrollbar; break; + case ViewSetting_ShowWhitespace: *value_out = vptr->file_data.show_whitespace; break; + case ViewSetting_ShowScrollbar: *value_out = !vptr->hide_scrollbar; break; + default: result = 0; break; } } diff --git a/4ed_file_view.cpp b/4ed_file_view.cpp index 806cd25c..a49b2218 100644 --- a/4ed_file_view.cpp +++ b/4ed_file_view.cpp @@ -284,8 +284,8 @@ view_file_display_width(View *view){ inline f32 view_file_minimum_base__width(View *view){ Editing_File *file = view->file_data.file; - f32 result = (f32)file->settings.display_width; - return(result); + f32 result = (f32)file->settings.display_width; + return(result); } inline f32 @@ -1066,7 +1066,7 @@ wrap_state_consume_token(Code_Wrap_State *state, i32 fixed_end_point){ } if (state->in_pp_body){ - if (!(state->token_ptr->flags & CPP_TFLAG_PP_BODY)){ + if (!(state->token_ptr->flags & CPP_TFLAG_PP_BODY)){ state->in_pp_body = 0; state->wrap_x = state->plane_wrap_x; } @@ -1252,7 +1252,7 @@ stickieness_guess(Cpp_Token_Type type, Cpp_Token_Type other_type, u16 flags, u16 } else{ if (other_is_words){ - guess = 100; + guess = 100; } } } @@ -1365,49 +1365,49 @@ get_current_shift(Code_Wrap_State *wrap_state, i32 next_line_start, b32 *adjust_ if (wrap_state->wrap_x.paren_safe_top != 0 && prev_token.type == CPP_TOKEN_PARENTHESE_OPEN){ current_shift = wrap_state->wrap_x.paren_nesting[wrap_state->wrap_x.paren_safe_top-1] + wrap_state->tab_indent_amount; - + *adjust_top_to_this = 1; + } + + f32 statement_continuation_indent = 0.f; + if (current_shift != 0.f && wrap_state->wrap_x.paren_safe_top == 0){ + if (!(prev_token.flags & CPP_TFLAG_PP_BODY) && !(prev_token.flags & CPP_TFLAG_PP_DIRECTIVE)){ + + switch (prev_token.type){ + case CPP_TOKEN_BRACKET_OPEN: + case CPP_TOKEN_BRACE_OPEN: + case CPP_TOKEN_BRACE_CLOSE: + case CPP_TOKEN_SEMICOLON: + case CPP_TOKEN_COLON: + case CPP_TOKEN_COMMA: + case CPP_TOKEN_COMMENT: break; + default: statement_continuation_indent += wrap_state->tab_indent_amount; break; + } + } + } + + switch (wrap_state->token_ptr->type){ + case CPP_TOKEN_BRACE_CLOSE: case CPP_TOKEN_BRACE_OPEN: break; + default: current_shift += statement_continuation_indent; break; + } } - f32 statement_continuation_indent = 0.f; - if (current_shift != 0.f && wrap_state->wrap_x.paren_safe_top == 0){ - if (!(prev_token.flags & CPP_TFLAG_PP_BODY) && !(prev_token.flags & CPP_TFLAG_PP_DIRECTIVE)){ - - switch (prev_token.type){ - case CPP_TOKEN_BRACKET_OPEN: - case CPP_TOKEN_BRACE_OPEN: - case CPP_TOKEN_BRACE_CLOSE: - case CPP_TOKEN_SEMICOLON: - case CPP_TOKEN_COLON: - case CPP_TOKEN_COMMA: - case CPP_TOKEN_COMMENT: break; - default: statement_continuation_indent += wrap_state->tab_indent_amount; break; - } - } - } - - switch (wrap_state->token_ptr->type){ - case CPP_TOKEN_BRACE_CLOSE: case CPP_TOKEN_BRACE_OPEN: break; - default: current_shift += statement_continuation_indent; break; + if (wrap_state->token_ptr->start < next_line_start){ + if (wrap_state->token_ptr->flags & CPP_TFLAG_PP_DIRECTIVE){ + current_shift = 0; + } + else{ + switch (wrap_state->token_ptr->type){ + case CPP_TOKEN_BRACE_CLOSE: + { + if (wrap_state->wrap_x.paren_safe_top == 0){ + current_shift -= wrap_state->tab_indent_amount; } - } - - if (wrap_state->token_ptr->start < next_line_start){ - if (wrap_state->token_ptr->flags & CPP_TFLAG_PP_DIRECTIVE){ - current_shift = 0; - } - else{ - switch (wrap_state->token_ptr->type){ - case CPP_TOKEN_BRACE_CLOSE: - { - if (wrap_state->wrap_x.paren_safe_top == 0){ - current_shift -= wrap_state->tab_indent_amount; - } - }break; - } - } - } - + }break; + } + } + } + return(current_shift); } @@ -1499,7 +1499,7 @@ file_measure_wraps(System_Functions *system, Models *models, Editing_File *file, b32 still_looping = 0; do{ for (; i < stream.end; ++i){ - u8 ch = stream.data[i]; + u8 ch = stream.data[i]; switch (word_stage){ case 0: @@ -1549,13 +1549,16 @@ file_measure_wraps(System_Functions *system, Models *models, Editing_File *file, if (use_tokens){ Code_Wrap_State original_wrap_state = wrap_state; - i32 next_line_start = params.buffer->line_starts[stop.line_index+1]; + i32 next_line_start = buffer_size(params.buffer); + if (stop.line_index+1 < params.buffer->line_count){ + next_line_start = params.buffer->line_starts[stop.line_index+1]; + } f32 base_adjusted_width = wrap_state.wrap_x.base_x + minimum_base_width; if (minimum_base_width != 0 && current_width < base_adjusted_width){ - current_width = base_adjusted_width; - } + current_width = base_adjusted_width; + } if (stop.status == BLStatus_NeedLineShift){ real_count = 0; @@ -1580,7 +1583,8 @@ file_measure_wraps(System_Functions *system, Models *models, Editing_File *file, b32 emit_comment_position = 0; b32 first_word = 1; - if (wrap_state.token_ptr->type == CPP_TOKEN_COMMENT){ + if (wrap_state.token_ptr->type == CPP_TOKEN_COMMENT || + wrap_state.token_ptr->type == CPP_TOKEN_STRING_CONSTANT){ i32 i = wrap_state.token_ptr->start; i32 end_i = i + wrap_state.token_ptr->size; @@ -1607,74 +1611,86 @@ file_measure_wraps(System_Functions *system, Models *models, Editing_File *file, potential_wrap.wrap_x = x; potential_wrap.adjust_top_to_this = 0; - if (buffer_stringify_loop(&stream, params.buffer, i, end_i)){ - b32 still_looping = 1; - - do{ - while (still_looping){ - for (; i < stream.end; ++i){ - u8 ch = stream.data[i]; - - if (char_is_whitespace(ch)){ - goto doublebreak_stage1; - } - - f32 adv = params.adv[ch]; - x += adv; - if (!first_word && x > current_width){ - emit_comment_position = 1; - goto doublebreak_stage1; + if (buffer_stringify_loop(&stream, params.buffer, i, end_i)){ + b32 still_looping = 1; + + while(still_looping){ + for (; i < stream.end; ++i){ + u8 ch = stream.data[i]; + + if (!char_is_whitespace(ch)){ + goto doublebreak_stage_vspace; } - } - still_looping = buffer_stringify_next(&stream); - } - doublebreak_stage1:; - first_word = 0; - - if (emit_comment_position){ - step.position_end = i; - step.final_x = x; - goto finished_comment_split; - } - - while(still_looping){ - for (; i < stream.end; ++i){ - u8 ch = stream.data[i]; - - if (!char_is_whitespace(ch)){ - goto doublebreak_stage2; + } + still_looping = buffer_stringify_next(&stream); + } + doublebreak_stage_vspace:; + + do{ + while (still_looping){ + for (; i < stream.end; ++i){ + u8 ch = stream.data[i]; + + if (char_is_whitespace(ch)){ + goto doublebreak_stage1; + } + + f32 adv = params.adv[ch]; + x += adv; + if (!first_word && x > current_width){ + emit_comment_position = 1; + goto doublebreak_stage1; + } + } + still_looping = buffer_stringify_next(&stream); + } + doublebreak_stage1:; + first_word = 0; + + if (emit_comment_position){ + step.position_end = i; + step.final_x = x; + goto finished_comment_split; } - f32 adv = params.adv[ch]; - x += adv; + while(still_looping){ + for (; i < stream.end; ++i){ + u8 ch = stream.data[i]; + + if (!char_is_whitespace(ch)){ + goto doublebreak_stage2; + } + + f32 adv = params.adv[ch]; + x += adv; + } + still_looping = buffer_stringify_next(&stream); + } + doublebreak_stage2:; + + potential_wrap.wrap_position = i; + potential_wrap.wrap_x = x; + }while(still_looping); } - still_looping = buffer_stringify_next(&stream); - } - doublebreak_stage2:; - - potential_wrap.wrap_position = i; - potential_wrap.wrap_x = x; - }while(still_looping); - } - - finished_comment_split:; - if (emit_comment_position){ - potential_marks[potential_count] = potential_wrap; - ++potential_count; - } - } + + finished_comment_split:; + if (emit_comment_position){ + potential_marks[potential_count] = potential_wrap; + ++potential_count; + } + } - if (!emit_comment_position){ - step = wrap_state_consume_token(&wrap_state, next_line_start-1); - } + if (!emit_comment_position){ + step = wrap_state_consume_token(&wrap_state, next_line_start-1); + } b32 need_to_choose_a_wrap = 0; if (step.final_x > current_width){ need_to_choose_a_wrap = 1; } - adjust_top_to_this = 0; - current_shift = get_current_shift(&wrap_state, next_line_start, &adjust_top_to_this); + adjust_top_to_this = 0; + current_shift = get_current_shift(&wrap_state, next_line_start, &adjust_top_to_this); b32 next_token_is_on_line = 0; if (wrap_state.token_ptr->start < next_line_start){ @@ -2146,78 +2162,78 @@ file_first_lex_serial(System_Functions *system, Mem_Options *mem, Editing_File * Temp_Memory temp = begin_temp_memory(part); Buffer_Type *buffer = &file->state.buffer; - i32 text_size = buffer_size(buffer); - + i32 text_size = buffer_size(buffer); + i32 mem_size = partition_remaining(part); Cpp_Token_Array tokens; tokens.max_count = mem_size / sizeof(Cpp_Token); tokens.count = 0; tokens.tokens = push_array(part, Cpp_Token, tokens.max_count); - - b32 still_lexing = 1; - - Cpp_Lex_Data lex = cpp_lex_data_init(); - - // TODO(allen): deduplicate this against relex - char *chunks[3]; - i32 chunk_sizes[3]; - - chunks[0] = buffer->data; - chunk_sizes[0] = buffer->size1; - - chunks[1] = buffer->data + buffer->size1 + buffer->gap_size; - chunk_sizes[1] = buffer->size2; - - chunks[2] = 0; - chunk_sizes[2] = 0; - - i32 chunk_index = 0; - - do{ - char *chunk = chunks[chunk_index]; - i32 chunk_size = chunk_sizes[chunk_index]; - - i32 result = cpp_lex_step(&lex, chunk, chunk_size, text_size, &tokens, NO_OUT_LIMIT); - - switch (result){ - case LexResult_NeedChunk: ++chunk_index; break; - case LexResult_NeedTokenMemory: InvalidCodePath; - case LexResult_HitTokenLimit: InvalidCodePath; - case LexResult_Finished: still_lexing = 0; break; - } - } while (still_lexing); - - i32 new_max = LargeRoundUp(tokens.count+1, Kbytes(1)); - - { - Assert(file->state.swap_array.tokens == 0); - file->state.swap_array.tokens = (Cpp_Token*) general_memory_allocate(system, general, new_max*sizeof(Cpp_Token)); - } - - u8 *dest = (u8*)file->state.swap_array.tokens; - u8 *src = (u8*)tokens.tokens; - - memcpy(dest, src, tokens.count*sizeof(Cpp_Token)); - - { - Cpp_Token_Array *file_token_array = &file->state.token_array; - file_token_array->count = tokens.count; - file_token_array->max_count = new_max; - if (file_token_array->tokens){ - general_memory_free(system, general, file_token_array->tokens); - } - file_token_array->tokens = file->state.swap_array.tokens; - file->state.swap_array.tokens = 0; - } - - // NOTE(allen): These are outside the locked section because I don't - // think getting these out of order will cause critical bugs, and I - // want to minimize what's done in locked sections. - file->state.tokens_complete = 1; - file->state.still_lexing = 0; - - end_temp_memory(temp); + + b32 still_lexing = 1; + + Cpp_Lex_Data lex = cpp_lex_data_init(); + + // TODO(allen): deduplicate this against relex + char *chunks[3]; + i32 chunk_sizes[3]; + + chunks[0] = buffer->data; + chunk_sizes[0] = buffer->size1; + + chunks[1] = buffer->data + buffer->size1 + buffer->gap_size; + chunk_sizes[1] = buffer->size2; + + chunks[2] = 0; + chunk_sizes[2] = 0; + + i32 chunk_index = 0; + + do{ + char *chunk = chunks[chunk_index]; + i32 chunk_size = chunk_sizes[chunk_index]; + + i32 result = cpp_lex_step(&lex, chunk, chunk_size, text_size, &tokens, NO_OUT_LIMIT); + + switch (result){ + case LexResult_NeedChunk: ++chunk_index; break; + case LexResult_NeedTokenMemory: InvalidCodePath; + case LexResult_HitTokenLimit: InvalidCodePath; + case LexResult_Finished: still_lexing = 0; break; + } + } while (still_lexing); + + i32 new_max = LargeRoundUp(tokens.count+1, Kbytes(1)); + + { + Assert(file->state.swap_array.tokens == 0); + file->state.swap_array.tokens = (Cpp_Token*) general_memory_allocate(system, general, new_max*sizeof(Cpp_Token)); + } + + u8 *dest = (u8*)file->state.swap_array.tokens; + u8 *src = (u8*)tokens.tokens; + + memcpy(dest, src, tokens.count*sizeof(Cpp_Token)); + + { + Cpp_Token_Array *file_token_array = &file->state.token_array; + file_token_array->count = tokens.count; + file_token_array->max_count = new_max; + if (file_token_array->tokens){ + general_memory_free(system, general, file_token_array->tokens); + } + file_token_array->tokens = file->state.swap_array.tokens; + file->state.swap_array.tokens = 0; + } + + // NOTE(allen): These are outside the locked section because I don't + // think getting these out of order will cause critical bugs, and I + // want to minimize what's done in locked sections. + file->state.tokens_complete = 1; + file->state.still_lexing = 0; + + end_temp_memory(temp); } file->state.tokens_complete = 1; @@ -2363,69 +2379,69 @@ file_relex_serial(System_Functions *system, Mem_Options *mem, Editing_File *file Assert(!file->state.still_lexing); - Buffer_Type *buffer = &file->state.buffer; - Cpp_Token_Array *array = &file->state.token_array; - - Temp_Memory temp = begin_temp_memory(part); - Cpp_Token_Array relex_array; - relex_array.count = 0; + Buffer_Type *buffer = &file->state.buffer; + Cpp_Token_Array *array = &file->state.token_array; + + Temp_Memory temp = begin_temp_memory(part); + Cpp_Token_Array relex_array; + relex_array.count = 0; relex_array.max_count = partition_remaining(part) / sizeof(Cpp_Token); - relex_array.tokens = push_array(part, Cpp_Token, relex_array.max_count); + relex_array.tokens = push_array(part, Cpp_Token, relex_array.max_count); + + i32 size = buffer_size(buffer); + + Cpp_Relex_Data state = cpp_relex_init(array, start_i, end_i, shift_amount); + + char *chunks[3]; + i32 chunk_sizes[3]; + + chunks[0] = buffer->data; + chunk_sizes[0] = buffer->size1; + + chunks[1] = buffer->data + buffer->size1 + buffer->gap_size; + chunk_sizes[1] = buffer->size2; + + chunks[2] = 0; + chunk_sizes[2] = 0; + + i32 chunk_index = 0; + char *chunk = chunks[chunk_index]; + i32 chunk_size = chunk_sizes[chunk_index]; + + while (!cpp_relex_is_start_chunk(&state, chunk, chunk_size)){ + ++chunk_index; + chunk = chunks[chunk_index]; + chunk_size = chunk_sizes[chunk_index]; + } + + for(;;){ + Cpp_Lex_Result lex_result = cpp_relex_step(&state, chunk, chunk_size, size, array, &relex_array); - i32 size = buffer_size(buffer); - - Cpp_Relex_Data state = cpp_relex_init(array, start_i, end_i, shift_amount); - - char *chunks[3]; - i32 chunk_sizes[3]; - - chunks[0] = buffer->data; - chunk_sizes[0] = buffer->size1; - - chunks[1] = buffer->data + buffer->size1 + buffer->gap_size; - chunk_sizes[1] = buffer->size2; - - chunks[2] = 0; - chunk_sizes[2] = 0; - - i32 chunk_index = 0; - char *chunk = chunks[chunk_index]; - i32 chunk_size = chunk_sizes[chunk_index]; - - while (!cpp_relex_is_start_chunk(&state, chunk, chunk_size)){ + switch (lex_result){ + case LexResult_NeedChunk: ++chunk_index; chunk = chunks[chunk_index]; chunk_size = chunk_sizes[chunk_index]; - } - - for(;;){ - Cpp_Lex_Result lex_result = cpp_relex_step(&state, chunk, chunk_size, size, array, &relex_array); + break; - switch (lex_result){ - case LexResult_NeedChunk: - ++chunk_index; - chunk = chunks[chunk_index]; - chunk_size = chunk_sizes[chunk_index]; - break; - - case LexResult_NeedTokenMemory: InvalidCodePath; - - case LexResult_Finished: goto doublebreak; - } - } - doublebreak:; - - i32 new_count = cpp_relex_get_new_count(&state, array->count, &relex_array); - if (new_count > array->max_count){ - i32 new_max = LargeRoundUp(new_count, Kbytes(1)); - array->tokens = (Cpp_Token*) - general_memory_reallocate(system, general, array->tokens, array->count*sizeof(Cpp_Token), new_max*sizeof(Cpp_Token)); - array->max_count = new_max; - } + case LexResult_NeedTokenMemory: InvalidCodePath; - cpp_relex_complete(&state, array, &relex_array); - - end_temp_memory(temp); + case LexResult_Finished: goto doublebreak; + } + } + doublebreak:; + + i32 new_count = cpp_relex_get_new_count(&state, array->count, &relex_array); + if (new_count > array->max_count){ + i32 new_max = LargeRoundUp(new_count, Kbytes(1)); + array->tokens = (Cpp_Token*) + general_memory_reallocate(system, general, array->tokens, array->count*sizeof(Cpp_Token), new_max*sizeof(Cpp_Token)); + array->max_count = new_max; + } + + cpp_relex_complete(&state, array, &relex_array); + + end_temp_memory(temp); return(1); } @@ -2755,7 +2771,7 @@ view_get_relative_scrolling(View *view){ internal void view_set_relative_scrolling(View *view, Relative_Scrolling scrolling){ f32 cursor_y = view_get_cursor_y(view); - + if (view->edit_pos){ view->edit_pos->scroll.scroll_y = cursor_y - scrolling.scroll_y; view->edit_pos->scroll.target_y = @@ -3116,7 +3132,7 @@ file_do_single_edit(System_Functions *system, Models *models, Editing_File *file // NOTE(allen): token fixing if (file->settings.tokens_exist){ if (!file->settings.virtual_white){ - file_relex_parallel(system, mem, file, start, end, shift_amount); + file_relex_parallel(system, mem, file, start, end, shift_amount); } else{ file_relex_serial(system, mem, file, start, end, shift_amount); @@ -3208,7 +3224,7 @@ file_do_batch_edit(System_Functions *system, Models *models, Editing_File *file, Buffer_Edit *last_edit = batch + batch_size - 1; if (!file->settings.virtual_white){ - file_relex_parallel(system, mem, file, first_edit->start, last_edit->end, shift_total); + file_relex_parallel(system, mem, file, first_edit->start, last_edit->end, shift_total); } else{ file_relex_serial(system, mem, file, first_edit->start, last_edit->end, shift_total); @@ -3724,13 +3740,13 @@ make_string_terminated(Partition *part, char *str, i32 len){ internal void init_normal_file(System_Functions *system, Models *models, Editing_File *file, char *buffer, i32 size){ - String val = make_string(buffer, size); + String val = make_string(buffer, size); file_create_from_string(system, models, file, val); Mem_Options *mem = &models->mem; if (file->settings.tokens_exist && file->state.token_array.tokens == 0){ if (!file->settings.virtual_white){ - file_first_lex_parallel(system, mem, file); + file_first_lex_parallel(system, mem, file); } else{ file_first_lex_serial(system, mem, file); @@ -3796,7 +3812,7 @@ view_open_file(System_Functions *system, Models *models, View *view, String file init_normal_file(system, models, file, buffer, size); } else{ - system->load_close(handle); + system->load_close(handle); } if (gen_buffer){ @@ -4037,24 +4053,24 @@ update_highlighting(View *view){ view->highlight = {}; return; } - + Editing_File *file = file_view->file; if (!file || !file_is_ready(file)){ view->highlight = {}; return; } - + Models *models = view->persistent.models; - + Style *style = &models->style; i32 pos = view_get_cursor_pos(file_view); char c = buffer_get_char(&file->state.buffer, pos); - + if (c == '\r'){ view->highlight.ids[0] = raw_ptr_dif(&style->main.special_character_color, style); } - + else if (file->state.tokens_complete){ Cpp_Token_Stack *tokens = &file->state.token_array; Cpp_Get_Token_Result result = cpp_get_token(tokens, pos); @@ -4080,7 +4096,7 @@ update_highlighting(View *view){ raw_ptr_dif(&style->main.highlight_white_color, style); } } - + else{ if (char_is_whitespace(c)){ view->highlight.ids[0] = 0; @@ -4093,7 +4109,7 @@ update_highlighting(View *view){ view->highlight.ids[1] = 0; } } - + if (file_view->show_temp_highlight){ view->highlight.ids[2] = raw_ptr_dif(&style->main.highlight_color, style); @@ -4123,9 +4139,9 @@ internal void intbar_draw_string(Render_Target *target, File_Bar *bar, String str, u32 char_color){ i16 font_id = bar->font_id; draw_string(target, font_id, str, - (i32)(bar->pos_x + bar->text_shift_x), - (i32)(bar->pos_y + bar->text_shift_y), - char_color); + (i32)(bar->pos_x + bar->text_shift_x), + (i32)(bar->pos_y + bar->text_shift_y), + char_color); bar->pos_x += font_string_width(target, font_id, str); } @@ -4408,10 +4424,10 @@ app_single_line_input_core(System_Functions *system, Working_Set *working_set, K inline Single_Line_Input_Step app_single_line_input_step(System_Functions *system, Key_Event_Data key, String *string){ - Single_Line_Mode mode = {}; - mode.type = SINGLE_LINE_STRING; - mode.string = string; - return app_single_line_input_core(system, 0, key, mode); + Single_Line_Mode mode = {}; + mode.type = SINGLE_LINE_STRING; + mode.string = string; + return app_single_line_input_core(system, 0, key, mode); } inline Single_Line_Input_Step @@ -4434,7 +4450,7 @@ app_single_number_input_step(System_Functions *system, Key_Event_Data key, Strin Single_Line_Mode mode = {}; mode.type = SINGLE_LINE_STRING; mode.string = string; - + char c = (char)key.character; if (c == 0 || c == '\n' || char_is_numeric(c)) result = app_single_line_input_core(system, 0, key, mode); @@ -5583,7 +5599,7 @@ click_button_input(GUI_Target *target, GUI_Session *session, Input_Summary *user b32 result = 0; i32 mx = user_input->mouse.x; i32 my = user_input->mouse.y; - + if (hit_check(mx, my, session->rect)){ target->hover = b->id; if (user_input->mouse.press_l){ @@ -5609,7 +5625,7 @@ scroll_button_input(GUI_Target *target, GUI_Session *session, Input_Summary *use b32 result = 0; i32 mx = user_input->mouse.x; i32 my = user_input->mouse.y; - + if (hit_check(mx, my, session->rect)){ target->hover = id; if (user_input->mouse.l){ diff --git a/TODO.txt b/TODO.txt index a51e2dc4..95a9afc4 100644 --- a/TODO.txt +++ b/TODO.txt @@ -76,6 +76,7 @@ ; [X] killing compilation panel changes active panel ; [X] make panel resizing not whacky with child panels ; [X] visual studio file saves aren't picked up by the file track system +; [X] findstr format not quite working ; ; [] indication on failure to save ; [] history is broken, revist the entire system @@ -85,6 +86,8 @@ ; [] view fails to follow cursor when the view is shrunk ; [] view fails to follow cursor after deleting long line ; +; [] over left-shifting the view? +; ; BEFORE I SHIP ; diff --git a/build.cpp b/build.cpp index 16e7f7d3..50f39d75 100644 --- a/build.cpp +++ b/build.cpp @@ -826,20 +826,20 @@ do_buildsuper(char *cdir){ //terminate_with_null(&str); //buildsuper(cdir, BUILD_DIR, str.str); #if defined(IS_WINDOWS) - //copy_sc(&str, "../code/internal_4coder_tests.cpp"); - //terminate_with_null(&str); - //buildsuper(cdir, BUILD_DIR, str.str); - copy_sc(&str, "../code/power/4coder_casey.cpp"); + copy_sc(&str, "../code/internal_4coder_tests.cpp"); terminate_with_null(&str); buildsuper(cdir, BUILD_DIR, str.str); - //copy_sc(&str, "../4vim/4coder_chronal.cpp"); - //terminate_with_null(&str); - //buildsuper(cdir, BUILD_DIR, str.str); #else copy_sc(&str, "../code/power/4coder_experiments.cpp"); terminate_with_null(&str); buildsuper(cdir, BUILD_DIR, str.str); #endif + //copy_sc(&str, "../code/power/4coder_casey.cpp"); + //terminate_with_null(&str); + //buildsuper(cdir, BUILD_DIR, str.str); + //copy_sc(&str, "../4vim/4coder_chronal.cpp"); + //terminate_with_null(&str); + //buildsuper(cdir, BUILD_DIR, str.str); END_TIME_SECTION("build custom"); } diff --git a/internal_4coder_string.cpp b/internal_4coder_string.cpp index d7672859..7f7170c3 100644 --- a/internal_4coder_string.cpp +++ b/internal_4coder_string.cpp @@ -1763,15 +1763,12 @@ This call returns non-zero on success.) */{ CPP_NAME(string_set_match) API_EXPORT FSTRING_LINK fstr_bool string_set_match_table(void *str_set, int32_t item_size, int32_t count, String str, int32_t *match_index)/* -DOC_PARAM(str_set, The str_set parameter may be an array of any type. -It should point at the String in the first element of the array.) -DOC_PARAM(count, The item_size parameter should describe the "stride" from one String to the next, in other -words it should be the size of one element of the array.) +DOC_PARAM(str_set, The str_set parameter may be an array of any type. It should point at the String in the first element of the array.) +DOC_PARAM(count, The item_size parameter should describe the "stride" from one String to the next, in other words it should be the size of one element of the array.) DOC_PARAM(count, The count parameter specifies the number of elements in the str_set array.) DOC_PARAM(str, The str parameter specifies the string to match against the str_set.) DOC_PARAM(match_index, If this call succeeds match_index is filled with the index into str_set where the match occurred.) -DOC(This call tries to see if str matches any of the strings in str_set. If there is a match the call -succeeds and returns non-zero. The matching rule is equivalent to the matching rule for match.) +DOC(This call tries to see if str matches any of the strings in str_set. If there is a match the call succeeds and returns non-zero. The matching rule is equivalent to the matching rule for match.) DOC_SEE(match) */{ fstr_bool result = 0; int32_t i = 0; @@ -1792,15 +1789,19 @@ DOC_PARAM(str_set, The str_set parameter is an array of String structs specifyin DOC_PARAM(count, The count parameter specifies the number of String structs in the str_set array.) DOC_PARAM(str, The str parameter specifies the string to match against the str_set.) DOC_PARAM(match_index, If this call succeeds match_index is filled with the index into str_set where the match occurred.) -DOC(This call tries to see if str matches any of the strings in str_set. If there is a match the call -succeeds and returns non-zero. The matching rule is equivalent to the matching rule for match.) +DOC(This call tries to see if str matches any of the strings in str_set. If there is a match the call succeeds and returns non-zero. The matching rule is equivalent to the matching rule for match.) DOC_SEE(match) */{ fstr_bool result = string_set_match_table(str_set, sizeof(String), count, str, match_index); return(result); } API_EXPORT FSTRING_LINK String -get_first_double_line(String source){ +get_first_double_line(String source)/* +DOC_PARAM(source, the source string accross which a 'double line' iteration will occur) +DOC_RETURN(The returned value is the first 'double line' in the source string.) +DOC(A 'double line' is a string of characters delimited by two new line characters. This call begins an iteration over all the double lines in the given source string.) +DOC_SEE(get_next_double_line) +*/{ String line = {0}; int32_t pos0 = find_substr_s(source, 0, make_lit_string("\n\n")); int32_t pos1 = find_substr_s(source, 0, make_lit_string("\r\n\r\n")); @@ -1812,7 +1813,12 @@ get_first_double_line(String source){ } API_EXPORT FSTRING_LINK String -get_next_double_line(String source, String line){ +get_next_double_line(String source, String line)/* +DOC_PARAM(source, the source string accross which the 'double line' iteration is occurring) +DOC_PARAM(line, the value returned from the previous call of get_first_double_line or get_next_double_line) +DOC_RETURN(The returned value is the first 'double line' in the source string.) +DOC_SEE(get_first_double_line) +*/{ String next = {0}; int32_t pos = (int32_t)(line.str - source.str) + line.size; int32_t start = 0, pos0 = 0, pos1 = 0; @@ -1835,7 +1841,12 @@ get_next_double_line(String source, String line){ } API_EXPORT FSTRING_LINK String -get_next_word(String source, String prev_word){ +get_next_word(String source, String prev_word)/* +DOC_PARAM(source, the source string accross which the 'word' iteration is occurring) +DOC_PARAM(line, the value returned from the previous call of get_first_word or get_next_word) +DOC_RETURN(The returned value is the first 'word' in the source string.) +DOC_SEE(get_first_word) +*/{ String word = {0}; int32_t pos0 = (int32_t)(prev_word.str - source.str) + prev_word.size; @@ -1864,7 +1875,12 @@ get_next_word(String source, String prev_word){ } API_EXPORT FSTRING_LINK String -get_first_word(String source){ +get_first_word(String source)/* +DOC_PARAM(source, the source string accross which a 'word' iteration will occur) +DOC_RETURN(The returned value is the first 'word' in the source string.) +DOC(A 'word' is a string of characters delimited by whitespace or parentheses. This call begins an iteration over all the double lines in the given source string.) +DOC_SEE(get_next_word) +*/{ String start_str = make_string(source.str, 0); String word = get_next_word(source, start_str); return(word); diff --git a/site/4ed_site.ctm b/site/4ed_site.ctm index f0a30ff6..17f9f220 100644 Binary files a/site/4ed_site.ctm and b/site/4ed_site.ctm differ diff --git a/site/abstract_document.cpp b/site/abstract_document.cpp index 832eed5e..5c37103d 100644 --- a/site/abstract_document.cpp +++ b/site/abstract_document.cpp @@ -47,6 +47,21 @@ enum{ Doc_Table_Of_Contents }; +typedef struct Alternate_Name{ + String macro; + String public_name; +} Alternate_Name; + +typedef struct Alternate_Names_Array{ + Alternate_Name *names; +} Alternate_Names_Array; + +enum{ + AltName_Standard, + AltName_Macro, + AltName_Public_Name, +}; + struct Document_Item{ Document_Item *next; Document_Item *parent; @@ -61,6 +76,8 @@ struct Document_Item{ struct{ Meta_Unit *unit; + Alternate_Names_Array *alt_names; + int32_t alt_name_type; } unit_elements; struct{ @@ -174,6 +191,19 @@ add_element_list(Abstract_Document *doc, Meta_Unit *unit){ append_child(parent, item); } +static void +add_element_list(Abstract_Document *doc, Meta_Unit *unit, Alternate_Names_Array *alt_names, int32_t alt_name_type){ + Document_Item *parent = doc->section_stack[doc->section_top]; + Document_Item *item = push_struct(doc->part, Document_Item); + *item = null_document_item; + item->type = Doc_Element_List; + item->unit_elements.unit = unit; + item->unit_elements.alt_names = alt_names; + item->unit_elements.alt_name_type = alt_name_type; + + append_child(parent, item); +} + static void add_full_elements(Abstract_Document *doc, Meta_Unit *unit){ Document_Item *parent = doc->section_stack[doc->section_top]; @@ -185,6 +215,19 @@ add_full_elements(Abstract_Document *doc, Meta_Unit *unit){ append_child(parent, item); } +static void +add_full_elements(Abstract_Document *doc, Meta_Unit *unit, Alternate_Names_Array *alt_names, int32_t alt_name_type){ + Document_Item *parent = doc->section_stack[doc->section_top]; + Document_Item *item = push_struct(doc->part, Document_Item); + *item = null_document_item; + item->type = Doc_Full_Elements; + item->unit_elements.unit = unit; + item->unit_elements.alt_names = alt_names; + item->unit_elements.alt_name_type = alt_name_type; + + append_child(parent, item); +} + static void add_table_of_contents(Abstract_Document *doc){ Document_Item *parent = doc->section_stack[doc->section_top]; @@ -253,15 +296,69 @@ struct Section_Counter{ }; static void -append_section_number(String *out, Section_Counter section_counter){ - for (int32_t i = 1; i <= section_counter.nest_level; ++i){ +append_section_number_reduced(String *out, Section_Counter section_counter, int32_t reduce){ + int32_t level = section_counter.nest_level-reduce; + for (int32_t i = 1; i <= level; ++i){ append_int_to_str(out, section_counter.counter[i]); - if (i != section_counter.nest_level){ + if (i != level){ append_sc(out, "."); } } } +static void +append_section_number(String *out, Section_Counter section_counter){ + append_section_number_reduced(out, section_counter, 0); +} + +static int32_t +extract_command_body(String *out, String l, int32_t *i_in_out, int32_t *body_start_out, int32_t *body_end_out, String command_name){ + int32_t result = 0; + + int32_t i = *i_in_out; + + for (; i < l.size; ++i){ + if (!char_is_whitespace(l.str[i])){ + break; + } + } + + int32_t found_command_body = 0; + int32_t body_start = 0, body_end = 0; + if (l.str[i] == '{'){ + body_start = i+1; + + for (++i; i < l.size; ++i){ + if (l.str[i] == '}'){ + found_command_body = 1; + body_end = i; + ++i; + break; + } + } + } + + if (found_command_body){ + result = 1; + } + else{ +#define STR_START "! Doc generator error: missing body for " + #define STR_SLOW " !" + append_sc(out, STR_START); + append_ss(out, command_name); + append_sc(out, STR_SLOW); +#undef STR + + fprintf(stderr, "error: missing body for %.*s\n", command_name.size, command_name.str); + } + + *i_in_out = i; + *body_start_out = body_start; + *body_end_out = body_end; + + return(result); +} + static void write_enriched_text_html(String *out, Enriched_Text *text){ String source = text->source; @@ -300,22 +397,48 @@ write_enriched_text_html(String *out, Enriched_Text *text){ make_lit_string("\\"), make_lit_string("VERSION"), make_lit_string("CODE_STYLE"), + make_lit_string("DOC_LINK"), }; + i = command_end; + int32_t match_index = 0; if (string_set_match(enriched_commands, ArrayCount(enriched_commands), command_string, &match_index)){ switch (match_index){ case 0: append_sc(out, "\\"); break; case 1: append_sc(out, VERSION); break; - case 2: append_sc(out, " TEST "); break; + case 2: + { + int32_t body_start = 0, body_end = 0; + int32_t has_body = extract_command_body(out, l, &i, &body_start, &body_end, command_string); + if (has_body){ + String body_text = substr(l, body_start, body_end - body_start); + append_sc(out, ""); + append_ss(out, body_text); + append_sc(out, ""); + } + }break; + + case 3: + { + int32_t body_start = 0, body_end = 0; + int32_t has_body = extract_command_body(out, l, &i, &body_start, &body_end, command_string); + if (has_body){ + String body_text = substr(l, body_start, body_end - body_start); + append_sc(out, ""); + append_ss(out, body_text); + append_sc(out, ""); + } + }break; } } else{ - append_sc(out,"! Doc generator error: unrecognized command !"); - fprintf(stderr, "error: Unrecognized command %.*s\n", command_string.size, command_string.str); + append_sc(out, "! Doc generator error: unrecognized command !"); + fprintf(stderr, "error: unrecognized command %.*s\n", command_string.size, command_string.str); } - i = command_end; start = i; } } @@ -329,9 +452,615 @@ write_enriched_text_html(String *out, Enriched_Text *text){ append_sc(out, ""); } - + + static void + print_item_in_list(String *out, String name, char *id_postfix){ + append_sc(out, "
  • "); + append_ss(out, name); + append_sc(out, "
    • "); + } + + static void + init_used_links(Partition *part, Used_Links *used, int32_t count){ + used->strs = push_array(part, String, count); + used->count = 0; + used->max = count; + } + + static int32_t + try_to_use(Used_Links *used, String str){ + int32_t result = 1; + int32_t index = 0; + + if (string_set_match(used->strs, used->count, str, &index)){ + result = 0; + } + else{ + used->strs[used->count++] = str; + } + + return(result); + } + + static void + print_struct_html(String *out, Item_Node *member, int32_t hide_children){ + String name = member->name; + String type = member->type; + String type_postfix = member->type_postfix; + + append_ss (out, type); + append_s_char (out, ' '); + append_ss (out, name); + append_ss (out, type_postfix); + + if (match_ss(type, make_lit_string("struct")) || + match_ss(type, make_lit_string("union"))){ + + if (hide_children){ + append_sc(out, " { /* non-public internals */ } ;"); + } + else{ + append_sc(out, " {
    "); + + for (Item_Node *member_iter = member->first_child; + member_iter != 0; + member_iter = member_iter->next_sibling){ + print_struct_html(out, member_iter, hide_children); + } + + append_sc(out, "
    };
    "); + } + } + else{ + append_sc(out, ";
    "); + } + } + + static void + print_function_html(String *out, Used_Links *used, String cpp_name, String ret, char *function_call_head, String name, Argument_Breakdown breakdown){ + + append_ss (out, ret); + append_s_char (out, ' '); + append_sc (out, function_call_head); + append_ss (out, name); + + if (breakdown.count == 0){ + append_sc(out, "()"); + } + else if (breakdown.count == 1){ + append_sc(out, "("); + append_ss(out, breakdown.args[0].param_string); + append_sc(out, ")"); + } + else{ + append_sc(out, "(
    "); + + for (int32_t j = 0; j < breakdown.count; ++j){ + append_ss(out, breakdown.args[j].param_string); + if (j < breakdown.count - 1){ + append_s_char(out, ','); + } + append_sc(out, "
    "); + } + + append_sc(out, "
    )"); + } + } + + static void + print_macro_html(String *out, String name, Argument_Breakdown breakdown){ + + append_sc (out, "#define "); + append_ss (out, name); + + if (breakdown.count == 0){ + append_sc(out, "()"); + } + else if (breakdown.count == 1){ + append_s_char (out, '('); + append_ss (out, breakdown.args[0].param_string); + append_s_char (out, ')'); + } + else{ + append_sc (out, "(
    "); + + for (int32_t j = 0; j < breakdown.count; ++j){ + append_ss(out, breakdown.args[j].param_string); + if (j < breakdown.count - 1){ + append_s_char(out, ','); + } + append_sc(out, "
    "); + } + + append_sc(out, ")
    )"); + } + } + + enum Doc_Chunk_Type{ + DocChunk_PlainText, + DocChunk_CodeExample, + + DocChunk_Count + }; + + static String doc_chunk_headers[] = { + make_lit_string(""), + make_lit_string("CODE_EXAMPLE"), + }; + + static String + get_next_doc_chunk(String source, String prev_chunk, Doc_Chunk_Type *type){ + String chunk = {0}; + String word = {0}; + int32_t pos = source.size; + int32_t word_index = 0; + Doc_Chunk_Type t = DocChunk_PlainText; + + int32_t start_pos = (int32_t)(prev_chunk.str - source.str) + prev_chunk.size; + String source_tail = substr_tail(source, start_pos); + + Assert(DocChunk_Count == ArrayCount(doc_chunk_headers)); + + for (word = get_first_word(source_tail); + word.str; + word = get_next_word(source_tail, word), ++word_index){ + + for (int32_t i = 1; i < DocChunk_Count; ++i){ + if (match_ss(word, doc_chunk_headers[i])){ + pos = (int32_t)(word.str - source.str); + t = (Doc_Chunk_Type)i; + goto doublebreak; + } + } + } + doublebreak:; + + *type = DocChunk_PlainText; + if (word_index == 0){ + *type = t; + + int32_t nest_level = 1; + int32_t i = find_s_char(source, pos, '('); + for (++i; i < source.size; ++i){ + if (source.str[i] == '('){ + ++nest_level; + } + else if (source.str[i] == ')'){ + --nest_level; + if (nest_level == 0){ + break; + } + } + } + + pos = i+1; + } + + chunk = substr(source, start_pos, pos - start_pos); + + int32_t is_all_white = 1; + for (int32_t i = 0; i < chunk.size; ++i){ + if (!char_is_whitespace(chunk.str[i])){ + is_all_white = 0; + break; + } + } + + if (is_all_white){ + chunk = null_string; + } + + return(chunk); + } + + static String + get_first_doc_chunk(String source, Doc_Chunk_Type *type){ + String start_str = make_string(source.str, 0); + String chunk = get_next_doc_chunk(source, start_str, type); + return(chunk); + } + + static void + print_doc_description(String *out, Partition *part, String src){ + Doc_Chunk_Type type; + + for (String chunk = get_first_doc_chunk(src, &type); + chunk.str; + chunk = get_next_doc_chunk(src, chunk, &type)){ + + switch (type){ + case DocChunk_PlainText: + { + for (String line = get_first_double_line(chunk); + line.str; + line = get_next_double_line(chunk, line)){ + append_ss(out, line); + append_sc(out, "

    "); + } + }break; + + case DocChunk_CodeExample: + { + int32_t start = 0; + int32_t end = chunk.size-1; + while (start < end && chunk.str[start] != '(') ++start; + start += 1; + while (end > start && chunk.str[end] != ')') --end; + + + append_sc(out, HTML_EXAMPLE_CODE_OPEN); + + if (start < end){ + String code_example = substr(chunk, start, end - start); + int32_t first_line = 1; + + for (String line = get_first_line(code_example); + line.str; + line = get_next_line(code_example, line)){ + + if (!(first_line && line.size == 0)){ + int32_t space_i = 0; + for (; space_i < line.size; ++space_i){ + if (line.str[space_i] == ' '){ + append_sc(out, " "); + } + else{ + break; + } + } + + String line_tail = substr_tail(line, space_i); + append_ss(out, line_tail); + append_sc(out, "
    "); + } + first_line = 0; + } + } + + append_sc(out, HTML_EXAMPLE_CODE_CLOSE); + }break; + } + } + } + + static void + print_struct_docs(String *out, Partition *part, Item_Node *member){ + for (Item_Node *member_iter = member->first_child; + member_iter != 0; + member_iter = member_iter->next_sibling){ + String type = member_iter->type; + if (match_ss(type, make_lit_string("struct")) || + match_ss(type, make_lit_string("union"))){ + print_struct_docs(out, part, member_iter); + } + else{ + Documentation doc = {0}; + perform_doc_parse(part, member_iter->doc_string, &doc); + + append_sc(out, "
    "); + + append_sc(out, "
    "HTML_DOC_ITEM_HEAD_INL_OPEN); + append_ss(out, member_iter->name); + append_sc(out, HTML_DOC_ITEM_HEAD_INL_CLOSE"
    "); + + append_sc(out, "
    "HTML_DOC_ITEM_OPEN); + print_doc_description(out, part, doc.main_doc); + append_sc(out, HTML_DOC_ITEM_CLOSE"
    "); + + append_sc(out, "
    "); + } + } + } + + static void + print_see_also(String *out, Documentation *doc){ + int32_t doc_see_count = doc->see_also_count; + if (doc_see_count > 0){ + append_sc(out, HTML_DOC_HEAD_OPEN"See Also"HTML_DOC_HEAD_CLOSE); + + for (int32_t j = 0; j < doc_see_count; ++j){ + String see_also = doc->see_also[j]; + append_sc(out, HTML_DOC_ITEM_OPEN""); + append_ss(out, see_also); + append_sc(out, ""HTML_DOC_ITEM_CLOSE); + } + } + } + + static void + print_function_docs(String *out, Partition *part, String name, String doc_string){ + if (doc_string.size == 0){ + append_sc(out, "No documentation generated for this function."); + fprintf(stderr, "warning: no documentation string for %.*s\n", name.size, name.str); + } + + Temp_Memory temp = begin_temp_memory(part); + + Documentation doc = {0}; + + perform_doc_parse(part, doc_string, &doc); + + int32_t doc_param_count = doc.param_count; + if (doc_param_count > 0){ + append_sc(out, HTML_DOC_HEAD_OPEN"Parameters"HTML_DOC_HEAD_CLOSE); + + for (int32_t j = 0; j < doc_param_count; ++j){ + String param_name = doc.param_name[j]; + String param_docs = doc.param_docs[j]; + + // TODO(allen): check that param_name is actually + // a parameter to this function! + + append_sc(out, "
    "HTML_DOC_ITEM_HEAD_OPEN); + append_ss(out, param_name); + append_sc(out, HTML_DOC_ITEM_HEAD_CLOSE"
    "HTML_DOC_ITEM_OPEN); + append_ss(out, param_docs); + append_sc(out, HTML_DOC_ITEM_CLOSE"
    "); + } + } + + String ret_doc = doc.return_doc; + if (ret_doc.size != 0){ + append_sc(out, HTML_DOC_HEAD_OPEN"Return"HTML_DOC_HEAD_CLOSE HTML_DOC_ITEM_OPEN); + append_ss(out, ret_doc); + append_sc(out, HTML_DOC_ITEM_CLOSE); + } + + String main_doc = doc.main_doc; + if (main_doc.size != 0){ + append_sc(out, HTML_DOC_HEAD_OPEN"Description"HTML_DOC_HEAD_CLOSE HTML_DOC_ITEM_OPEN); + print_doc_description(out, part, main_doc); + append_sc(out, HTML_DOC_ITEM_CLOSE); + } + + print_see_also(out, &doc); + + end_temp_memory(temp); + } + + static void + print_item_html(String *out, Partition *part, Used_Links *used, Item_Node *item, char *id_postfix, char *section, int32_t I, Alternate_Name *alt_name, int32_t alt_name_type){ + Temp_Memory temp = begin_temp_memory(part); + + String name = item->name; + + switch (alt_name_type){ + case AltName_Macro: + { + name = alt_name->macro; + }break; + + case AltName_Public_Name: + { + name = alt_name->public_name; + }break; + } + + /* NOTE(allen): + Open a div for the whole item. + Put a heading in it with the name and section. + Open a "descriptive" box for the display of the code interface. + */ + append_sc(out, "
    "); + + int32_t has_cpp_name = 0; + if (item->cpp_name.str != 0){ + if (try_to_use(used, item->cpp_name)){ + append_sc(out, "
    "); + has_cpp_name = 1; + } + } + + append_sc (out, "

    §"); + append_sc (out, section); + append_s_char (out, '.'); + append_int_to_str (out, I); + append_sc (out, ": "); + append_ss (out, name); + append_sc (out, "

    "); + + append_sc(out, "
    "); + + switch (item->t){ + case Item_Function: + { + // NOTE(allen): Code box + print_function_html(out, used, item->cpp_name, item->ret, "", name, item->breakdown); + + // NOTE(allen): Close the code box + append_sc(out, "
    "); + + // NOTE(allen): Descriptive section + print_function_docs(out, part, name, item->doc_string); + }break; + + case Item_Macro: + { + // NOTE(allen): Code box + print_macro_html(out, name, item->breakdown); + + // NOTE(allen): Close the code box + append_sc(out, "
    "); + + // NOTE(allen): Descriptive section + print_function_docs(out, part, name, item->doc_string); + }break; + + case Item_Typedef: + { + String type = item->type; + + // NOTE(allen): Code box + append_sc (out, "typedef "); + append_ss (out, type); + append_s_char (out, ' '); + append_ss (out, name); + append_s_char (out, ';'); + + // NOTE(allen): Close the code box + append_sc(out, "
    "); + + // NOTE(allen): Descriptive section + String doc_string = item->doc_string; + Documentation doc = {0}; + perform_doc_parse(part, doc_string, &doc); + + String main_doc = doc.main_doc; + if (main_doc.size != 0){ + append_sc(out, HTML_DOC_HEAD_OPEN"Description"HTML_DOC_HEAD_CLOSE); + + append_sc(out, HTML_DOC_ITEM_OPEN); + print_doc_description(out, part, main_doc); + append_sc(out, HTML_DOC_ITEM_CLOSE); + } + else{ + fprintf(stderr, "warning: no documentation string for %.*s\n", name.size, name.str); + } + + print_see_also(out, &doc); + + }break; + + case Item_Enum: + { + // NOTE(allen): Code box + append_sc (out, "enum "); + append_ss (out, name); + append_s_char (out, ';'); + + // NOTE(allen): Close the code box + append_sc(out, ""); + + // NOTE(allen): Descriptive section + String doc_string = item->doc_string; + Documentation doc = {0}; + perform_doc_parse(part, doc_string, &doc); + + String main_doc = doc.main_doc; + if (main_doc.size != 0){ + append_sc(out, HTML_DOC_HEAD_OPEN"Description"HTML_DOC_HEAD_CLOSE); + + append_sc(out, HTML_DOC_ITEM_OPEN); + print_doc_description(out, part, main_doc); + append_sc(out, HTML_DOC_ITEM_CLOSE); + } + else{ + fprintf(stderr, "warning: no documentation string for %.*s\n", name.size, name.str); + } + + if (item->first_child){ + append_sc(out, HTML_DOC_HEAD_OPEN"Values"HTML_DOC_HEAD_CLOSE); + + for (Item_Node *member = item->first_child; + member; + member = member->next_sibling){ + Documentation doc = {0}; + perform_doc_parse(part, member->doc_string, &doc); + + append_sc(out, "
    "); + + // NOTE(allen): Dafuq is this all? + append_sc(out, "
    "HTML_DOC_ITEM_HEAD_INL_OPEN); + append_ss(out, member->name); + append_sc(out, HTML_DOC_ITEM_HEAD_INL_CLOSE); + + if (member->value.str){ + append_sc(out, " = "); + append_ss(out, member->value); + } + + append_sc(out, "
    "); + + append_sc(out, "
    "HTML_DOC_ITEM_OPEN); + print_doc_description(out, part, doc.main_doc); + append_sc(out, HTML_DOC_ITEM_CLOSE"
    "); + + append_sc(out, "
    "); + } + } + + print_see_also(out, &doc); + + }break; + + case Item_Struct: case Item_Union: + { + String doc_string = item->doc_string; + + int32_t hide_members = 0; + + if (doc_string.size == 0){ + hide_members = 1; + } + else{ + for (String word = get_first_word(doc_string); + word.str; + word = get_next_word(doc_string, word)){ + if (match_ss(word, make_lit_string("HIDE_MEMBERS"))){ + hide_members = 1; + break; + } + } + } + + // NOTE(allen): Code box + print_struct_html(out, item, hide_members); + + // NOTE(allen): Close the code box + append_sc(out, ""); + + // NOTE(allen): Descriptive section + { + Documentation doc = {0}; + perform_doc_parse(part, doc_string, &doc); + + String main_doc = doc.main_doc; + if (main_doc.size != 0){ + append_sc(out, HTML_DOC_HEAD_OPEN"Description"HTML_DOC_HEAD_CLOSE); + + append_sc(out, HTML_DOC_ITEM_OPEN); + print_doc_description(out, part, main_doc); + append_sc(out, HTML_DOC_ITEM_CLOSE); + } + else{ + fprintf(stderr, "warning: no documentation string for %.*s\n", name.size, name.str); + } + + if (!hide_members){ + if (item->first_child){ + append_sc(out, HTML_DOC_HEAD_OPEN"Fields"HTML_DOC_HEAD_CLOSE); + print_struct_docs(out, part, item); + } + } + + print_see_also(out, &doc); + } + }break; + } + + if (has_cpp_name){ + append_sc(out, ""); + } + + // NOTE(allen): Close the item box + append_sc(out, "
    "); + + end_temp_memory(temp); + } + static void -doc_item_head_html(String *out, Document_Item *item, Section_Counter section_counter){ + doc_item_head_html(String *out, Partition *part, Used_Links *used_links, Document_Item *item, Section_Counter section_counter){ switch (item->type){ case Doc_Root: { @@ -432,11 +1161,75 @@ doc_item_head_html(String *out, Document_Item *item, Section_Counter section_cou } }break; + case Doc_Todo: + { + append_sc(out, "
    Coming Soon
    "); + }break; + case Doc_Enriched_Text: { write_enriched_text_html(out, item->text.text); }break; + case Doc_Element_List: + { + append_sc(out, "
      "); + + Meta_Unit *unit = item->unit_elements.unit; + Alternate_Names_Array *alt_names = item->unit_elements.alt_names; + int32_t count = unit->set.count; + + switch (item->unit_elements.alt_name_type){ + case AltName_Standard: + { + for (int32_t i = 0; i < count; ++i){ + print_item_in_list(out, unit->set.items[i].name, "_doc"); + } + }break; + + case AltName_Macro: + { + for (int32_t i = 0; i < count; ++i){ + print_item_in_list(out, alt_names->names[i].macro, "_doc"); + } + }break; + + case AltName_Public_Name: + { + for (int32_t i = 0; i < count; ++i){ + print_item_in_list(out, alt_names->names[i].public_name, "_doc"); + } + }break; + } + + append_sc(out, "
    "); + }break; + + case Doc_Full_Elements: + { + Meta_Unit *unit = item->unit_elements.unit; + Alternate_Names_Array *alt_names = item->unit_elements.alt_names; + int32_t count = unit->set.count; + + char section_space[32]; + String section_str = make_fixed_width_string(section_space); + append_section_number_reduced(§ion_str, section_counter, 1); + terminate_with_null(§ion_str); + + if (alt_names){ + int32_t I = 1; + for (int32_t i = 0; i < count; ++i, ++I){ + print_item_html(out, part, used_links, &unit->set.items[i], "_doc", section_str.str, I, &alt_names->names[i], item->unit_elements.alt_name_type); + } + } + else{ + int32_t I = 1; + for (int32_t i = 0; i < count; ++i, ++I){ + print_item_html(out, part, used_links, &unit->set.items[i], "_doc", section_str.str, I, 0, 0); + } + } + }break; + case Doc_Table_Of_Contents: { append_sc(out, "

    Table of Contents

      "); @@ -468,7 +1261,7 @@ doc_item_head_html(String *out, Document_Item *item, Section_Counter section_cou } static void -doc_item_foot_html(String *out, Document_Item *item, Section_Counter section_counter){ +doc_item_foot_html(String *out, Partition *part, Used_Links *used_links, Document_Item *item, Section_Counter section_counter){ switch (item->type){ case Doc_Root: { @@ -482,9 +1275,9 @@ doc_item_foot_html(String *out, Document_Item *item, Section_Counter section_cou } static void -generate_item_html(String *out, Document_Item *item, Section_Counter *section_counter){ +generate_item_html(String *out, Partition *part, Used_Links *used_links, Document_Item *item, Section_Counter *section_counter){ Section_Counter sc = *section_counter; - doc_item_head_html(out, item, sc); + doc_item_head_html(out, part, used_links, item, sc); if (item->type == Doc_Root || item->type == Doc_Section){ int32_t level = ++section_counter->nest_level; @@ -492,20 +1285,23 @@ generate_item_html(String *out, Document_Item *item, Section_Counter *section_co for (Document_Item *m = item->section.first_child; m != 0; m = m->next){ - generate_item_html(out, m, section_counter); + generate_item_html(out, part, used_links, m, section_counter); } --section_counter->nest_level; ++section_counter->counter[section_counter->nest_level]; } - doc_item_foot_html(out, item, sc); + doc_item_foot_html(out, part, used_links, item, sc); } static void -generate_document_html(String *out, Abstract_Document *doc){ +generate_document_html(String *out, Partition *part, Abstract_Document *doc){ + Used_Links used_links = {0}; + init_used_links(part, &used_links, 4000); + Section_Counter section_counter = {0}; section_counter.counter[section_counter.nest_level] = 1; - generate_item_html(out, doc->root_item, §ion_counter); + generate_item_html(out, part, &used_links, doc->root_item, §ion_counter); } #endif diff --git a/site/sitegen.cpp b/site/sitegen.cpp index 935963a1..099cad25 100644 --- a/site/sitegen.cpp +++ b/site/sitegen.cpp @@ -33,122 +33,6 @@ // Meta Parse Rules // -static void -init_used_links(Partition *part, Used_Links *used, int32_t count){ - used->strs = push_array(part, String, count); - used->count = 0; - used->max = count; -} - -static int32_t -try_to_use(Used_Links *used, String str){ - int32_t result = 1; - int32_t index = 0; - - if (string_set_match(used->strs, used->count, str, &index)){ - result = 0; - } - else{ - used->strs[used->count++] = str; - } - - return(result); -} - -static void -print_struct_html(String *out, Item_Node *member, int32_t hide_children){ - String name = member->name; - String type = member->type; - String type_postfix = member->type_postfix; - - append_ss (out, type); - append_s_char (out, ' '); - append_ss (out, name); - append_ss (out, type_postfix); - - if (match_ss(type, make_lit_string("struct")) || - match_ss(type, make_lit_string("union"))){ - - if (hide_children){ - append_sc(out, " { /* non-public internals */ } ;"); - } - else{ - append_sc(out, " {
      "); - - for (Item_Node *member_iter = member->first_child; - member_iter != 0; - member_iter = member_iter->next_sibling){ - print_struct_html(out, member_iter, hide_children); - } - - append_sc(out, "
      };
      "); - } - } - else{ - append_sc(out, ";
      "); - } -} - -static void -print_function_html(String *out, Used_Links *used, String cpp_name, String ret, char *function_call_head, String name, Argument_Breakdown breakdown){ - - append_ss (out, ret); - append_s_char (out, ' '); - append_sc (out, function_call_head); - append_ss (out, name); - - if (breakdown.count == 0){ - append_sc(out, "()"); -} -else if (breakdown.count == 1){ - append_sc(out, "("); - append_ss(out, breakdown.args[0].param_string); - append_sc(out, ")"); -} -else{ - append_sc(out, "(
      "); - - for (int32_t j = 0; j < breakdown.count; ++j){ - append_ss(out, breakdown.args[j].param_string); - if (j < breakdown.count - 1){ - append_s_char(out, ','); - } - append_sc(out, "
      "); - } - - append_sc(out, "
      )"); -} -} - -static void -print_macro_html(String *out, String name, Argument_Breakdown breakdown){ - - append_sc (out, "#define "); - append_ss (out, name); - - if (breakdown.count == 0){ - append_sc(out, "()"); - } - else if (breakdown.count == 1){ - append_s_char (out, '('); - append_ss (out, breakdown.args[0].param_string); - append_s_char (out, ')'); - } - else{ - append_sc (out, "(
      "); - - for (int32_t j = 0; j < breakdown.count; ++j){ - append_ss(out, breakdown.args[j].param_string); - if (j < breakdown.count - 1){ - append_s_char(out, ','); - } - append_sc(out, "
      "); - } - - append_sc(out, ")
      )"); - } -} - #define BACK_COLOR "#FAFAFA" #define TEXT_COLOR "#0D0D0D" #define CODE_BACK "#DFDFDF" @@ -186,199 +70,6 @@ print_macro_html(String *out, String name, Argument_Breakdown breakdown){ #define EXAMPLE_CODE_OPEN "
      " #define EXAMPLE_CODE_CLOSE "
      " -enum Doc_Chunk_Type{ - DocChunk_PlainText, - DocChunk_CodeExample, - - DocChunk_Count -}; - -static String doc_chunk_headers[] = { - make_lit_string(""), - make_lit_string("CODE_EXAMPLE"), -}; - -static String -get_next_doc_chunk(String source, String prev_chunk, Doc_Chunk_Type *type){ - String chunk = {0}; - String word = {0}; - int32_t pos = source.size; - int32_t word_index = 0; - Doc_Chunk_Type t = DocChunk_PlainText; - - int32_t start_pos = (int32_t)(prev_chunk.str - source.str) + prev_chunk.size; - String source_tail = substr_tail(source, start_pos); - - Assert(DocChunk_Count == ArrayCount(doc_chunk_headers)); - - for (word = get_first_word(source_tail); - word.str; - word = get_next_word(source_tail, word), ++word_index){ - - for (int32_t i = 1; i < DocChunk_Count; ++i){ - if (match_ss(word, doc_chunk_headers[i])){ - pos = (int32_t)(word.str - source.str); - t = (Doc_Chunk_Type)i; - goto doublebreak; - } - } - } - doublebreak:; - - *type = DocChunk_PlainText; - if (word_index == 0){ - *type = t; - - int32_t nest_level = 1; - int32_t i = find_s_char(source, pos, '('); - for (++i; i < source.size; ++i){ - if (source.str[i] == '('){ - ++nest_level; - } - else if (source.str[i] == ')'){ - --nest_level; - if (nest_level == 0){ - break; - } - } - } - - pos = i+1; - } - - chunk = substr(source, start_pos, pos - start_pos); - - int32_t is_all_white = 1; - for (int32_t i = 0; i < chunk.size; ++i){ - if (!char_is_whitespace(chunk.str[i])){ - is_all_white = 0; - break; - } - } - - if (is_all_white){ - chunk = null_string; - } - - return(chunk); -} - -static String -get_first_doc_chunk(String source, Doc_Chunk_Type *type){ - String start_str = make_string(source.str, 0); - String chunk = get_next_doc_chunk(source, start_str, type); - return(chunk); -} - -static void -print_doc_description(String *out, Partition *part, String src){ - Doc_Chunk_Type type; - - for (String chunk = get_first_doc_chunk(src, &type); - chunk.str; - chunk = get_next_doc_chunk(src, chunk, &type)){ - - switch (type){ - case DocChunk_PlainText: - { - for (String line = get_first_double_line(chunk); - line.str; - line = get_next_double_line(chunk, line)){ - append_ss(out, line); - append_sc(out, "

      "); - } - }break; - - case DocChunk_CodeExample: - { - int32_t start = 0; - int32_t end = chunk.size-1; - while (start < end && chunk.str[start] != '(') ++start; - start += 1; - while (end > start && chunk.str[end] != ')') --end; - - - append_sc(out, EXAMPLE_CODE_OPEN); - - if (start < end){ - String code_example = substr(chunk, start, end - start); - int32_t first_line = 1; - - for (String line = get_first_line(code_example); - line.str; - line = get_next_line(code_example, line)){ - - if (!(first_line && line.size == 0)){ - int32_t space_i = 0; - for (; space_i < line.size; ++space_i){ - if (line.str[space_i] == ' '){ - append_sc(out, " "); - } - else{ - break; - } - } - - String line_tail = substr_tail(line, space_i); - append_ss(out, line_tail); - append_sc(out, "
      "); - } - first_line = 0; - } - } - - append_sc(out, EXAMPLE_CODE_CLOSE); - }break; - } - } -} - -static void -print_struct_docs(String *out, Partition *part, Item_Node *member){ - for (Item_Node *member_iter = member->first_child; - member_iter != 0; - member_iter = member_iter->next_sibling){ - String type = member_iter->type; - if (match_ss(type, make_lit_string("struct")) || - match_ss(type, make_lit_string("union"))){ - print_struct_docs(out, part, member_iter); - } - else{ - Documentation doc = {0}; - perform_doc_parse(part, member_iter->doc_string, &doc); - - append_sc(out, "
      "); - - append_sc(out, "
      "DOC_ITEM_HEAD_INL_OPEN); - append_ss(out, member_iter->name); - append_sc(out, DOC_ITEM_HEAD_INL_CLOSE"
      "); - - append_sc(out, "
      "DOC_ITEM_OPEN); - print_doc_description(out, part, doc.main_doc); - append_sc(out, DOC_ITEM_CLOSE"
      "); - - append_sc(out, "
      "); - } - } -} - -static void -print_see_also(String *out, Documentation *doc){ - int32_t doc_see_count = doc->see_also_count; - if (doc_see_count > 0){ - append_sc(out, DOC_HEAD_OPEN"See Also"DOC_HEAD_CLOSE); - - for (int32_t j = 0; j < doc_see_count; ++j){ - String see_also = doc->see_also[j]; - append_sc(out, DOC_ITEM_OPEN""); - append_ss(out, see_also); - append_sc(out, ""DOC_ITEM_CLOSE); - } - } -} - static void print_function_body_code(String *out, Parse_Context *context, int32_t start){ String pstr = {0}, lexeme = {0}; @@ -426,311 +117,15 @@ print_function_body_code(String *out, Parse_Context *context, int32_t start){ } } } - -static void -print_function_docs(String *out, Partition *part, String name, String doc_string){ - if (doc_string.size == 0){ - append_sc(out, "No documentation generated for this function."); - fprintf(stderr, "warning: no documentation string for %.*s\n", name.size, name.str); - } - - Temp_Memory temp = begin_temp_memory(part); - - Documentation doc = {0}; - - perform_doc_parse(part, doc_string, &doc); - - int32_t doc_param_count = doc.param_count; - if (doc_param_count > 0){ - append_sc(out, DOC_HEAD_OPEN"Parameters"DOC_HEAD_CLOSE); - - for (int32_t j = 0; j < doc_param_count; ++j){ - String param_name = doc.param_name[j]; - String param_docs = doc.param_docs[j]; - - // TODO(allen): check that param_name is actually - // a parameter to this function! - - append_sc(out, "
      "DOC_ITEM_HEAD_OPEN); - append_ss(out, param_name); - append_sc(out, DOC_ITEM_HEAD_CLOSE"
      "DOC_ITEM_OPEN); - append_ss(out, param_docs); - append_sc(out, DOC_ITEM_CLOSE"
      "); - } - } - - String ret_doc = doc.return_doc; - if (ret_doc.size != 0){ - append_sc(out, DOC_HEAD_OPEN"Return"DOC_HEAD_CLOSE DOC_ITEM_OPEN); - append_ss(out, ret_doc); - append_sc(out, DOC_ITEM_CLOSE); - } - - String main_doc = doc.main_doc; - if (main_doc.size != 0){ - append_sc(out, DOC_HEAD_OPEN"Description"DOC_HEAD_CLOSE DOC_ITEM_OPEN); - print_doc_description(out, part, main_doc); - append_sc(out, DOC_ITEM_CLOSE); - } - - print_see_also(out, &doc); - - end_temp_memory(temp); -} - -static void -print_item_in_list(String *out, String name, char *id_postfix){ - append_sc(out, "
    • "); - append_ss(out, name); - append_sc(out, "
      • "); -} - -static void -print_item(String *out, Partition *part, Used_Links *used, - Item_Node *item, char *id_postfix, char *function_prefix, - char *section, int32_t I){ - Temp_Memory temp = begin_temp_memory(part); - - String name = item->name; - /* NOTE(allen): - Open a div for the whole item. - Put a heading in it with the name and section. - Open a "descriptive" box for the display of the code interface. - */ - append_sc(out, "
      "); - - int32_t has_cpp_name = 0; - if (item->cpp_name.str != 0){ - if (try_to_use(used, item->cpp_name)){ - append_sc(out, "
      "); - has_cpp_name = 1; - } - } - - append_sc (out, "

      §"); - append_sc (out, section); - append_s_char (out, '.'); - append_int_to_str (out, I); - append_sc (out, ": "); - append_ss (out, name); - append_sc (out, "

      "); - - append_sc(out, "
      "); - - switch (item->t){ - case Item_Function: - { - // NOTE(allen): Code box - Assert(function_prefix != 0); - print_function_html(out, used, item->cpp_name, item->ret, function_prefix, item->name, item->breakdown); - - // NOTE(allen): Close the code box - append_sc(out, "
      "); - - // NOTE(allen): Descriptive section - print_function_docs(out, part, item->name, item->doc_string); - }break; - - case Item_Macro: - { - // NOTE(allen): Code box - print_macro_html(out, item->name, item->breakdown); - - // NOTE(allen): Close the code box - append_sc(out, "
      "); - - // NOTE(allen): Descriptive section - print_function_docs(out, part, item->name, item->doc_string); - }break; - - case Item_Typedef: - { - String type = item->type; - - // NOTE(allen): Code box - append_sc (out, "typedef "); - append_ss (out, type); - append_s_char (out, ' '); - append_ss (out, name); - append_s_char (out, ';'); - - // NOTE(allen): Close the code box - append_sc(out, "
      "); - - // NOTE(allen): Descriptive section - String doc_string = item->doc_string; - Documentation doc = {0}; - perform_doc_parse(part, doc_string, &doc); - - String main_doc = doc.main_doc; - if (main_doc.size != 0){ - append_sc(out, DOC_HEAD_OPEN"Description"DOC_HEAD_CLOSE); - - append_sc(out, DOC_ITEM_OPEN); - print_doc_description(out, part, main_doc); - append_sc(out, DOC_ITEM_CLOSE); - } - else{ - fprintf(stderr, "warning: no documentation string for %.*s\n", name.size, name.str); - } - - print_see_also(out, &doc); - - }break; - - case Item_Enum: - { - // NOTE(allen): Code box - append_sc (out, "enum "); - append_ss (out, name); - append_s_char (out, ';'); - - // NOTE(allen): Close the code box - append_sc(out, "
    "); - - // NOTE(allen): Descriptive section - String doc_string = item->doc_string; - Documentation doc = {0}; - perform_doc_parse(part, doc_string, &doc); - - String main_doc = doc.main_doc; - if (main_doc.size != 0){ - append_sc(out, DOC_HEAD_OPEN"Description"DOC_HEAD_CLOSE); - - append_sc(out, DOC_ITEM_OPEN); - print_doc_description(out, part, main_doc); - append_sc(out, DOC_ITEM_CLOSE); - } - else{ - fprintf(stderr, "warning: no documentation string for %.*s\n", name.size, name.str); - } - - if (item->first_child){ - append_sc(out, DOC_HEAD_OPEN"Values"DOC_HEAD_CLOSE); - - for (Item_Node *member = item->first_child; - member; - member = member->next_sibling){ - Documentation doc = {0}; - perform_doc_parse(part, member->doc_string, &doc); - - append_sc(out, "
    "); - - // NOTE(allen): Dafuq is this all? - append_sc(out, "
    "DOC_ITEM_HEAD_INL_OPEN); - append_ss(out, member->name); - append_sc(out, DOC_ITEM_HEAD_INL_CLOSE); - - if (member->value.str){ - append_sc(out, " = "); - append_ss(out, member->value); - } - - append_sc(out, "
    "); - - append_sc(out, "
    "DOC_ITEM_OPEN); - print_doc_description(out, part, doc.main_doc); - append_sc(out, DOC_ITEM_CLOSE"
    "); - - append_sc(out, "
    "); - } - } - - print_see_also(out, &doc); - - }break; - - case Item_Struct: case Item_Union: - { - String doc_string = item->doc_string; - - int32_t hide_members = 0; - - if (doc_string.size == 0){ - hide_members = 1; - } - else{ - for (String word = get_first_word(doc_string); - word.str; - word = get_next_word(doc_string, word)){ - if (match_ss(word, make_lit_string("HIDE_MEMBERS"))){ - hide_members = 1; - break; - } - } - } - - // NOTE(allen): Code box - print_struct_html(out, item, hide_members); - - // NOTE(allen): Close the code box - append_sc(out, "
    "); - - // NOTE(allen): Descriptive section - { - Documentation doc = {0}; - perform_doc_parse(part, doc_string, &doc); - - String main_doc = doc.main_doc; - if (main_doc.size != 0){ - append_sc(out, DOC_HEAD_OPEN"Description"DOC_HEAD_CLOSE); - - append_sc(out, DOC_ITEM_OPEN); - print_doc_description(out, part, main_doc); - append_sc(out, DOC_ITEM_CLOSE); - } - else{ - fprintf(stderr, "warning: no documentation string for %.*s\n", name.size, name.str); - } - - if (!hide_members){ - if (item->first_child){ - append_sc(out, DOC_HEAD_OPEN"Fields"DOC_HEAD_CLOSE); - print_struct_docs(out, part, item); - } - } - - print_see_also(out, &doc); - } - }break; - } - - if (has_cpp_name){ - append_sc(out, ""); - } - - // NOTE(allen): Close the item box - append_sc(out, "
    "); - - end_temp_memory(temp); -} - -typedef struct App_API_Name{ - String macro; - String public_name; -} App_API_Name; - -typedef struct App_API{ - App_API_Name *names; -} App_API; - -static App_API + +static Alternate_Names_Array allocate_app_api(Partition *part, int32_t count){ - App_API app_api = {0}; - app_api.names = push_array(part, App_API_Name, count); - memset(app_api.names, 0, sizeof(App_API_Name)*count); + Alternate_Names_Array app_api = {0}; + app_api.names = push_array(part, Alternate_Name, count); + memset(app_api.names, 0, sizeof(Alternate_Name)*count); return(app_api); } - + static void assert_files_are_equal(char *directory, char *filename1, char *filename2){ char space[256]; @@ -739,17 +134,17 @@ assert_files_are_equal(char *directory, char *filename1, char *filename2){ append_sc(&name, "\\"); append_sc(&name, filename1); terminate_with_null(&name); - + String file1 = file_dump(name.str); - + name.size = 0; append_sc(&name, directory); append_sc(&name, "\\"); append_sc(&name, filename2); terminate_with_null(&name); - + String file2 = file_dump(name.str); - + if (!match_ss(file1, file2)){ fprintf(stderr, "Failed transitional test: %s != %s\n", filename1, filename2); } @@ -757,18 +152,18 @@ assert_files_are_equal(char *directory, char *filename1, char *filename2){ fprintf(stderr, "Passed transitional test: %s == %s\n", filename1, filename2); } } - + static void generate_site(char *code_directory, char *src_directory, char *dst_directory){ #define API_DOC "4coder_API.html" - + int32_t size = (512 << 20); void *mem = malloc(size); memset(mem, 0, size); - + Partition part_ = make_part(mem, size); Partition *part = &part_; - + static Meta_Keywords meta_keywords[] = { {make_lit_string("API_EXPORT") , Item_Function } , {make_lit_string("API_EXPORT_INLINE") , Item_Function } , @@ -779,79 +174,80 @@ generate_site(char *code_directory, char *src_directory, char *dst_directory){ {make_lit_string("UNION") , Item_Union } , {make_lit_string("ENUM") , Item_Enum } , }; - + #define ExpandArray(a) (a), (ArrayCount(a)) - + // NOTE(allen): Parse the important code. Meta_Unit custom_types_unit = compile_meta_unit(part, code_directory, "4coder_types.h", ExpandArray(meta_keywords)); - + Meta_Unit lexer_funcs_unit = compile_meta_unit(part, code_directory, "4cpp_lexer.h", ExpandArray(meta_keywords)); - + Meta_Unit lexer_types_unit = compile_meta_unit(part, code_directory, "4cpp_lexer_types.h", ExpandArray(meta_keywords)); - + Meta_Unit string_unit = compile_meta_unit(part, code_directory, "internal_4coder_string.cpp", ExpandArray(meta_keywords)); - + static char *functions_files[] = { "4ed_api_implementation.cpp", "win32_api_impl.cpp", 0 }; - + Meta_Unit custom_funcs_unit = compile_meta_unit(part, code_directory, functions_files, ExpandArray(meta_keywords)); - - + + // NOTE(allen): Compute and store variations of the custom function names - App_API func_4ed_names = allocate_app_api(part, custom_funcs_unit.set.count); - + Alternate_Names_Array custom_func_names = allocate_app_api(part, custom_funcs_unit.set.count); + for (int32_t i = 0; i < custom_funcs_unit.set.count; ++i){ String name_string = custom_funcs_unit.set.items[i].name; - String *macro = &func_4ed_names.names[i].macro; - String *public_name = &func_4ed_names.names[i].public_name; - + String *macro = &custom_func_names.names[i].macro; + String *public_name = &custom_func_names.names[i].public_name; + *macro = str_alloc(part, name_string.size+4); to_upper_ss(macro, name_string); append_ss(macro, make_lit_string("_SIG")); - + *public_name = str_alloc(part, name_string.size); to_lower_ss(public_name, name_string); - + partition_align(part, 4); } - + // NOTE(allen): Load enriched text materials Enriched_Text introduction = load_enriched_text(part, src_directory, "introduction.txt"); - + Enriched_Text lexer_introduction = load_enriched_text(part, src_directory, "lexer_introduction.txt"); + // NOTE(allen): Put together the abstract document Abstract_Document doc = {0}; begin_document_description(&doc, part, "4coder API Docs"); - + add_table_of_contents(&doc); - + begin_section(&doc, "Introduction", "introduction"); add_enriched_text(&doc, &introduction); end_section(&doc); - + begin_section(&doc, "4coder Systems", "4coder_systems"); add_todo(&doc); end_section(&doc); - + begin_section(&doc, "Types and Functions", "types_and_functions"); { begin_section(&doc, "Function List", 0); - add_element_list(&doc, &custom_funcs_unit); + add_element_list(&doc, &custom_funcs_unit, &custom_func_names, AltName_Public_Name); end_section(&doc); begin_section(&doc, "Type List", 0); add_element_list(&doc, &custom_types_unit); end_section(&doc); begin_section(&doc, "Function Descriptions", 0); - add_full_elements(&doc, &custom_funcs_unit); + add_full_elements(&doc, &custom_funcs_unit, &custom_func_names, AltName_Public_Name); end_section(&doc); begin_section(&doc, "Type Descriptions", 0); add_full_elements(&doc, &custom_types_unit); end_section(&doc); } end_section(&doc); - + begin_section(&doc, "String Library", "string_library"); { begin_section(&doc, "String Library Intro", 0); @@ -865,11 +261,11 @@ generate_site(char *code_directory, char *src_directory, char *dst_directory){ end_section(&doc); } end_section(&doc); - + begin_section(&doc, "Lexer Library", "lexer_library"); { begin_section(&doc, "Lexer Intro", 0); - add_todo(&doc); + add_enriched_text(&doc, &lexer_introduction); end_section(&doc); begin_section(&doc, "Lexer Function List", 0); add_element_list(&doc, &lexer_funcs_unit); @@ -885,359 +281,23 @@ generate_site(char *code_directory, char *src_directory, char *dst_directory){ end_section(&doc); } end_section(&doc); - + end_document_description(&doc); - + // NOTE(allen): Output String out = str_alloc(part, 10 << 20); Out_Context context = {0}; set_context_directory(&context, dst_directory); - - // Output Docs - General Document Generator - if (begin_file_out(&context, "gen-test.html", &out)){ - generate_document_html(&out, &doc); - end_file_out(context); - } - else{ - // TODO(allen): warning - } - - // Output Docs - Direct Method + + // Output Docs if (begin_file_out(&context, API_DOC, &out)){ - Used_Links used_links = {0}; - init_used_links(part, &used_links, 4000); - - append_sc(&out, - "" - "" - "4coder API Docs" - "" - "\n" - "" - "
    " - //"

    4cpp Lexing Library

    "); - - "

    4coder API Docs

    "); - - struct Section{ - char *id_string; - char *display_string; - }; - - static int32_t msection = -1; - - static Section sections[] = { - {"introduction", "Introduction"}, - {"4coder_systems", "4coder Systems"}, - {"types_and_functions", "Types and Functions"}, - {"string_library", "String Library"}, - {"lexer_library", "Lexer Library"} - }; - - append_sc(&out, "

    Table of Contents

    "); - -#define MAJOR_SECTION "1" - msection = 0; - - append_sc(&out, "\n

    §"MAJOR_SECTION" "); - append_sc(&out, sections[msection].display_string); - append_sc(&out, "

    "); - -#if 0 - // NOTE(allen): doc intro for lexer standalone - append_sc(&out, - "
    " - "

    This is the documentation for the 4cpp lexer version 1.1. " - "The documentation is the newest piece of this lexer project " - "so it may still have problems. What is here should be correct " - "and mostly complete.

    " - "

    If you have questions or discover errors please contact " - "editor@4coder.net or " - "to get help from community members you can post on the " - "4coder forums hosted on handmade.network at " - "4coder.handmade.network

    " - "
    "); -#endif - - append_sc(&out, - "
    " - "

    This is the documentation for " VERSION ". The documentation is still " - "under construction so some of the links are linking to sections that " - "have not been written yet. What is here should be correct and I suspect " - "useful even without some of the other sections.

    " - "

    If you have questions or discover errors please contact " - "editor@4coder.net or " - "to get help from members of the 4coder and handmade network community you " - "can post on the 4coder forums hosted at " - "4coder.handmade.network

    " - "
    "); - -#undef MAJOR_SECTION -#define MAJOR_SECTION "2" - msection = 1; - - // TODO(allen): Write the 4coder system descriptions. - append_sc(&out, "\n

    §"MAJOR_SECTION" "); - append_sc(&out, sections[msection].display_string); - append_sc(&out, "

    "); - - append_sc(&out, "
    Coming Soon
    "); - -#undef MAJOR_SECTION -#define MAJOR_SECTION "3" - msection = 2; - - append_sc(&out, "\n

    §"MAJOR_SECTION" "); - append_sc(&out, sections[msection].display_string); - append_sc(&out, "

    "); - -#undef SECTION -#define SECTION MAJOR_SECTION".1" - - append_sc(&out, "

    §"SECTION" Function List

      "); - for (int32_t i = 0; i < custom_funcs_unit.set.count; ++i){ - print_item_in_list(&out, func_4ed_names.names[i].public_name, "_doc"); - } - append_sc(&out, "
    "); - -#undef SECTION -#define SECTION MAJOR_SECTION".2" - - append_sc(&out, "

    §"SECTION" Type List

      "); - for (int32_t i = 0; i < custom_types_unit.set.count; ++i){ - print_item_in_list(&out, custom_types_unit.set.items[i].name, "_doc"); - } - append_sc(&out, "
    "); - -#undef SECTION -#define SECTION MAJOR_SECTION".3" - - append_sc(&out, "

    §"SECTION" Function Descriptions

    "); - for (int32_t i = 0; i < custom_funcs_unit.set.count; ++i){ - Item_Node *item = &custom_funcs_unit.set.items[i]; - String name = func_4ed_names.names[i].public_name; - - append_sc (&out, "

    §"SECTION"."); - append_int_to_str(&out, i+1); - append_sc (&out, ": "); - append_ss (&out, name); - append_sc (&out, "

    "); - - print_function_html(&out, &used_links, item->cpp_name, item->ret, "", name, item->breakdown); - append_sc(&out, "
    "); - - print_function_docs(&out, part, name, item->doc_string); - - append_sc(&out, "
    "); - } - -#undef SECTION -#define SECTION MAJOR_SECTION".4" - - append_sc(&out, "

    §"SECTION" Type Descriptions

    "); - - int32_t I = 1; - for (int32_t i = 0; i < custom_types_unit.set.count; ++i, ++I){ - print_item(&out, part, &used_links, custom_types_unit.set.items + i, "_doc", 0, SECTION, I); - } - -#undef MAJOR_SECTION -#define MAJOR_SECTION "4" - msection = 3; - - append_sc(&out, "\n

    §"MAJOR_SECTION" "); - append_sc(&out, sections[msection].display_string); - append_sc(&out, "

    "); - -#undef SECTION -#define SECTION MAJOR_SECTION".1" - - append_sc(&out, "

    §"SECTION" String Intro

    "); - - append_sc(&out, "
    Coming Soon
    "); - -#undef SECTION -#define SECTION MAJOR_SECTION".2" - - append_sc(&out, "

    §"SECTION" String Function List

    "); - - append_sc(&out, "
      "); - for (int32_t i = 0; i < string_unit.set.count; ++i){ - print_item_in_list(&out, string_unit.set.items[i].name, "_doc"); - } - append_sc(&out, "
    "); - -#undef SECTION -#define SECTION MAJOR_SECTION".3" - - append_sc(&out, "

    §"SECTION" String Function Descriptions

    "); - - for (int32_t i = 0; i < string_unit.set.count; ++i){ - print_item(&out, part, &used_links, string_unit.set.items+i, "_doc", "", SECTION, i+1); - } - -#undef MAJOR_SECTION -#define MAJOR_SECTION "5" - msection = 4; - - append_sc(&out, "\n

    §"MAJOR_SECTION" "); - append_sc(&out, sections[msection].display_string); - append_sc(&out, "

    "); - -#undef SECTION -#define SECTION MAJOR_SECTION".1" - - append_sc(&out, "

    §"SECTION" Lexer Intro

    "); - - append_sc(&out, - "
    " - "The 4cpp lexer system provides a polished, fast, flexible system that " - "takes in C/C++ and outputs a tokenization of the text data. There are " - "two API levels. One level is setup to let you easily get a tokenization " - "of the file. This level manages memory for you with malloc to make it " - "as fast as possible to start getting your tokens. The second level " - "enables deep integration by allowing control over allocation, data " - "chunking, and output rate control.

    " - "To use the quick setup API you simply include 4cpp_lexer.h and read the " - "documentation at cpp_lex_file.

    " - "To use the the fancier API include 4cpp_lexer.h and read the " - "documentation at cpp_lex_step. " - "If you want to be absolutely sure you are not including malloc into " - "your program you can define FCPP_FORBID_MALLOC before the include and " - "the \"step\" API will continue to work.

    " - "There are a few more features in 4cpp that are not documented yet. " - "You are free to try to use these, but I am not totally sure they are " - "ready yet, and when they are they will be documented." - "
    "); - -#undef SECTION -#define SECTION MAJOR_SECTION".2" - - append_sc(&out, "

    §"SECTION" Lexer Function List

    "); - - append_sc(&out, "
      "); - for (int32_t i = 0; i < lexer_funcs_unit.set.count; ++i){ - print_item_in_list(&out, lexer_funcs_unit.set.items[i].name, "_doc"); - } - append_sc(&out, "
    "); - -#undef SECTION -#define SECTION MAJOR_SECTION".3" - - append_sc(&out, "

    §"SECTION" Lexer Types List

    "); - - append_sc(&out, "
      "); - for (int32_t i = 0; i < lexer_types_unit.set.count; ++i){ - print_item_in_list(&out, lexer_types_unit.set.items[i].name, "_doc"); - } - append_sc(&out, "
    "); - -#undef SECTION -#define SECTION MAJOR_SECTION".4" - - append_sc(&out, "

    §"SECTION" Lexer Function Descriptions

    "); - for (int32_t i = 0; i < lexer_funcs_unit.set.count; ++i){ - print_item(&out, part, &used_links, lexer_funcs_unit.set.items+i, "_doc", "", SECTION, i+1); - } - -#undef SECTION -#define SECTION MAJOR_SECTION".5" - - append_sc(&out, "

    §"SECTION" Lexer Type Descriptions

    "); - for (int32_t i = 0; i < lexer_types_unit.set.count; ++i){ - print_item(&out, part, &used_links, lexer_types_unit.set.items+i, "_doc", "", SECTION, i+1); - } - - append_sc(&out, "
    "); + generate_document_html(&out, part, &doc); end_file_out(context); } else{ // TODO(allen): warning } - // Here to test the file equality tester - // Output Docs - General Document Generator - if (begin_file_out(&context, "gen-test2.html", &out)){ - generate_document_html(&out, &doc); - end_file_out(context); - } - else{ - // TODO(allen): warning - } - - assert_files_are_equal(dst_directory, API_DOC, API_DOC); - assert_files_are_equal(dst_directory, "gen-test.html", "gen-test2.html"); - assert_files_are_equal(dst_directory, API_DOC, "gen-test.html"); } int main(int argc, char **argv){ diff --git a/site/source_material/lexer_introduction.txt b/site/source_material/lexer_introduction.txt index 66e8719e..e693ea18 100644 --- a/site/source_material/lexer_introduction.txt +++ b/site/source_material/lexer_introduction.txt @@ -1,4 +1,8 @@ -This is the documentation for the 4cpp lexer version \VERSION. The documentation is the newest piece of this lexer project so it may still have problems. What is here should be correct and mostly complete. +The 4cpp lexer system provides a polished, fast, flexible system that takes in C/C++ and outputs a tokenization of the text data. There are two API levels. One level is setup to let you easily get a tokenization of the file. This level manages memory for you with malloc to make it as fast as possible to start getting your tokens. The second level enables deep integration by allowing control over allocation, data chunking, and output rate control. -If you have questions or discover errors please contact \CODE_STYLE{editor@4coder.net} or to get help from members of the 4coder and handmade network community you can post on the 4coder forums hosted at \CODE_STYLE{4coder.handmade.network}. \ No newline at end of file +To use the quick setup API you simply include 4cpp_lexer.h and read the documentation at \DOC_LINK{cpp_lex_file}. + +To use the the fancier API include 4cpp_lexer.h and read the documentation at \DOC_LINK{cpp_lex_step}. If you want to be absolutely sure you are not including malloc into your program you can define FCPP_FORBID_MALLOC before the include and the "step" API will continue to work. + +There are a few more features in 4cpp that are not documented yet. You are free to try to use these, but I am not totally sure they are ready yet, and when they are they will be documented.