4coder/4coder_jump_sticky.cpp

614 lines
23 KiB
C++

/*
4coder_jump_sticky.cpp - Commands and helpers for parsing jump locations from
compiler errors, sticking markers on jump locations, and jumping to them.
*/
// TOP
static Marker_List_Node *marker_list_first = 0;
static Marker_List_Node *marker_list_last = 0;
////////////////////////////////
static u32
binary_search(u32 *array, i32 stride, i32 count, u32 x){
u8 *raw = (u8*)array;
u32 i = 0;
u32 first = 0;
u32 last = count;
if (first < last){
for (;;){
i = (first + last)/2;
u32 k = *(u32*)(raw + stride*i);
if (k < x){
first = i;
}
else if (k > x){
last = i;
}
else{ // NOTE(allen): array[i] == x
break;
}
if (first + 1 >= last){
i = first;
break;
}
}
}
return(i);
}
static Sticky_Jump_Array
parse_buffer_to_jump_array(Application_Links *app, Partition *arena, Buffer_Summary buffer){
Sticky_Jump_Array result = {};
result.jumps = push_array(arena, Sticky_Jump, 0);
for (i32 line = 1;; line += 1){
b32 output_jump = false;
i32 colon_index = 0;
b32 is_sub_error = false;
Buffer_ID out_buffer_id = 0;
i32 out_pos = 0;
Temp_Memory temp = begin_temp_memory(arena);
String line_str = {};
if (read_line(app, arena, &buffer, line, &line_str)){
Name_Line_Column_Location location = {};
if (parse_jump_location(line_str, &location, &colon_index, &is_sub_error)){
Buffer_Summary jump_buffer = {};
if (open_file(app, &jump_buffer, location.file.str, location.file.size, false, true)){
if (jump_buffer.exists){
Partial_Cursor cursor = {};
if (buffer_compute_cursor(app, &jump_buffer,
seek_line_char(location.line, location.column),
&cursor)){
out_buffer_id = jump_buffer.buffer_id;
out_pos = cursor.pos;
output_jump = true;
}
}
}
}
}
else{
end_temp_memory(temp);
break;
}
end_temp_memory(temp);
if (output_jump){
Sticky_Jump *jump = push_array(arena, Sticky_Jump, 1);
jump->list_line = line;
jump->list_colon_index = colon_index;
jump->is_sub_error = is_sub_error;
jump->jump_buffer_id = out_buffer_id;
jump->jump_pos = out_pos;
}
}
result.count = (i32)(push_array(arena, Sticky_Jump, 0) - result.jumps);
return(result);
}
static char sticky_jump_marker_handle_var[] = "DEFAULT.sticky_jump_marker_handle";
static i32 sticky_jump_marker_handle_loc;
static void
init_marker_list(Application_Links *app, Partition *scratch, Heap *heap, Buffer_ID buffer_id,
Marker_List *list){
Buffer_Summary buffer = get_buffer(app, buffer_id, AccessAll);
b32 is_compilation_buffer = match(make_string(buffer.buffer_name, buffer.buffer_name_len), "*compilation*");
Temp_Memory temp = begin_temp_memory(scratch);
Sticky_Jump_Array jumps = parse_buffer_to_jump_array(app, scratch, buffer);
Range_Array buffer_ranges = get_ranges_of_duplicate_keys(scratch,
&jumps.jumps->jump_buffer_id, sizeof(*jumps.jumps),
jumps.count);
Sort_Pair_i32 *range_index_buffer_id_pairs = push_array(scratch, Sort_Pair_i32, buffer_ranges.count);
for (i32 i = 0; i < buffer_ranges.count; i += 1){
range_index_buffer_id_pairs[i].index = i;
range_index_buffer_id_pairs[i].key = jumps.jumps[buffer_ranges.ranges[i].first].jump_buffer_id;
}
sort_pairs_by_key(range_index_buffer_id_pairs, buffer_ranges.count);
Range_Array scoped_buffer_ranges = get_ranges_of_duplicate_keys(scratch,
&range_index_buffer_id_pairs->key,
sizeof(*range_index_buffer_id_pairs),
buffer_ranges.count);
Sticky_Jump_Stored *stored = push_array(scratch, Sticky_Jump_Stored, jumps.count);
Managed_Scope scope_array[2] = {};
scope_array[0] = buffer_get_managed_scope(app, buffer_id);
for (i32 i = 0; i < scoped_buffer_ranges.count; i += 1){
Range buffer_range_indices = scoped_buffer_ranges.ranges[i];
Temp_Memory marker_temp = begin_temp_memory(scratch);
Marker *markers = push_array(scratch, Marker, 0);
u32 total_jump_count = 0;
Buffer_ID target_buffer_id = 0;
for (i32 j = buffer_range_indices.first;
j < buffer_range_indices.one_past_last;
j += 1){
i32 range_index = range_index_buffer_id_pairs[j].index;
Range range = buffer_ranges.ranges[range_index];
if (target_buffer_id == 0){
target_buffer_id = jumps.jumps[range.first].jump_buffer_id;
}
for (i32 k = range.first; k < range.one_past_last; k += 1){
Marker *new_marker = push_array(scratch, Marker, 1);
new_marker->pos = jumps.jumps[k].jump_pos;
new_marker->lean_right = false;
stored[k].list_line = jumps.jumps[k].list_line;
stored[k].list_colon_index = jumps.jumps[k].list_colon_index;
stored[k].is_sub_error = jumps.jumps[k].is_sub_error;
stored[k].jump_buffer_id = jumps.jumps[k].jump_buffer_id;
stored[k].index_into_marker_array = total_jump_count;
total_jump_count += 1;
}
}
scope_array[1] = buffer_get_managed_scope(app, target_buffer_id);
Managed_Scope scope = get_managed_scope_with_multiple_dependencies(app, scope_array, ArrayCount(scope_array));
Managed_Object marker_handle = alloc_buffer_markers_on_buffer(app, target_buffer_id, total_jump_count, &scope);
managed_object_store_data(app, marker_handle, 0, total_jump_count, markers);
if (is_compilation_buffer){
Marker_Visual visual = create_marker_visual(app, marker_handle);
marker_visual_set_effect(app, visual, VisualType_LineHighlights, Stag_Highlight_Junk, 0, 0);
}
end_temp_memory(marker_temp);
Assert(managed_object_get_item_size(app, marker_handle) == sizeof(Marker));
Assert(managed_object_get_item_count(app, marker_handle) == total_jump_count);
Assert(managed_object_get_type(app, marker_handle) == ManagedObjectType_Markers);
sticky_jump_marker_handle_loc = managed_variable_create_or_get_id(app, sticky_jump_marker_handle_var, 0);
managed_variable_set(app, scope, sticky_jump_marker_handle_loc, marker_handle);
}
Managed_Object stored_jump_array = alloc_managed_memory_in_scope(app, scope_array[0], sizeof(Sticky_Jump_Stored), jumps.count);
managed_object_store_data(app, stored_jump_array, 0, jumps.count, stored);
end_temp_memory(temp);
list->jump_array = stored_jump_array;
list->jump_count = jumps.count;
list->previous_size = buffer.size;
list->buffer_id = buffer_id;
}
static void
delete_marker_list(Marker_List_Node *node){
zdll_remove(marker_list_first, marker_list_last, node);
}
static void
delete_marker_list(Marker_List *list){
delete_marker_list(CastFromMember(Marker_List_Node, list, list));
}
static Marker_List*
make_new_marker_list_for_buffer(Heap *heap, i32 buffer_id){
Marker_List_Node *new_node = heap_array(heap, Marker_List_Node, 1);
zdll_push_back(marker_list_first, marker_list_last, new_node);
new_node->buffer_id = buffer_id;
memset(&new_node->list, 0, sizeof(new_node->list));
Marker_List *result = &new_node->list;
return(result);
}
static Marker_List*
get_marker_list_for_buffer(Buffer_ID buffer_id){
for (Marker_List_Node *node = marker_list_first;
node != 0;
node = node->next){
if (buffer_id == node->buffer_id){
return(&node->list);
}
}
return(0);
}
static Marker_List*
get_or_make_list_for_buffer(Application_Links *app, Partition *scratch, Heap *heap, Buffer_ID buffer_id){
Marker_List *result = get_marker_list_for_buffer(buffer_id);
if (result != 0){
Buffer_Summary buffer = get_buffer(app, buffer_id, AccessAll);
// TODO(allen): When buffers get an "edit sequence number" use that instead.
if (result->previous_size != buffer.size){
delete_marker_list(result);
result = 0;
}
}
if (result == 0){
result = make_new_marker_list_for_buffer(heap, buffer_id);
init_marker_list(app, scratch, heap, buffer_id, result);
if (result->jump_count == 0){
delete_marker_list(result);
result = 0;
}
}
return(result);
}
static b32
get_stored_jump_from_list(Application_Links *app, Marker_List *list, i32 index,
Sticky_Jump_Stored *stored_out){
Sticky_Jump_Stored stored = {};
if (list != 0){
if (managed_object_load_data(app, list->jump_array, index, 1, &stored)){
*stored_out = stored;
return(true);
}
}
return(false);
}
static Sticky_Jump_Stored*
get_all_stored_jumps_from_list(Application_Links *app, Partition *arena, Marker_List *list){
Sticky_Jump_Stored *stored = 0;
if (list != 0){
Temp_Memory restore_point = begin_temp_memory(arena);
stored = push_array(arena, Sticky_Jump_Stored, list->jump_count);
if (stored != 0){
if (!managed_object_load_data(app, list->jump_array, 0, list->jump_count, stored)){
stored = 0;
end_temp_memory(restore_point);
}
}
}
return(stored);
}
static b32
get_jump_from_list(Application_Links *app, Marker_List *list, i32 index, ID_Pos_Jump_Location *location){
b32 result = false;
Sticky_Jump_Stored stored = {};
if (get_stored_jump_from_list(app, list, index, &stored)){
Buffer_ID target_buffer_id = stored.jump_buffer_id;
Managed_Scope scope_array[2] = {};
scope_array[0] = buffer_get_managed_scope(app, list->buffer_id);
scope_array[1] = buffer_get_managed_scope(app, target_buffer_id);
Managed_Scope scope = get_managed_scope_with_multiple_dependencies(app, scope_array, ArrayCount(scope_array));
sticky_jump_marker_handle_loc = managed_variable_create_or_get_id(app, sticky_jump_marker_handle_var, 0);
Managed_Object marker_array = 0;
if (managed_variable_get(app, scope, sticky_jump_marker_handle_loc, &marker_array)){
Marker marker = {};
managed_object_load_data(app, marker_array, stored.index_into_marker_array, 1, &marker);
location->buffer_id = target_buffer_id;
location->pos = marker.pos;
result = true;
}
}
return(result);
}
static i32
get_line_from_list(Application_Links *app, Marker_List *list, i32 index){
i32 result = 0;
if (list != 0){
Sticky_Jump_Stored stored = {};
if (get_stored_jump_from_list(app, list, index, &stored)){
result = stored.list_line;
}
}
return(result);
}
static b32
get_is_sub_error_from_list(Application_Links *app, Marker_List *list, i32 index){
b32 result = false;
if (list != 0){
Sticky_Jump_Stored stored = {};
if (get_stored_jump_from_list(app, list, index, &stored)){
result = stored.is_sub_error;
}
}
return(result);
}
static i32
get_index_nearest_from_list(Application_Links *app, Partition *scratch, Marker_List *list, i32 line){
i32 result = -1;
if (list != 0){
Temp_Memory temp = begin_temp_memory(scratch);
Sticky_Jump_Stored *stored = get_all_stored_jumps_from_list(app, scratch, list);
if (stored != 0){
result = binary_search((u32*)&stored->list_line, sizeof(*stored), list->jump_count, line);
}
end_temp_memory(temp);
}
return(result);
}
static i32
get_index_exact_from_list(Application_Links *app, Partition *scratch, Marker_List *list, i32 line){
i32 result = -1;
if (list != 0){
Temp_Memory temp = begin_temp_memory(scratch);
Sticky_Jump_Stored *stored = get_all_stored_jumps_from_list(app, scratch, list);
if (stored != 0){
i32 index = binary_search((u32*)&stored->list_line, sizeof(*stored), list->jump_count, line);
if (stored[index].list_line == line){
result = index;
}
}
end_temp_memory(temp);
}
return(result);
}
CUSTOM_COMMAND_SIG(goto_jump_at_cursor_sticky)
CUSTOM_DOC("If the cursor is found to be on a jump location, parses the jump location and brings up the file and position in another view and changes the active panel to the view containing the jump.")
{
Heap *heap = &global_heap;
Partition *part = &global_part;
Temp_Memory temp = begin_temp_memory(part);
View_Summary view = get_active_view(app, AccessProtected);
Marker_List *list = get_or_make_list_for_buffer(app, part, heap, view.buffer_id);
i32 list_index = get_index_exact_from_list(app, part, list, view.cursor.line);
if (list_index >= 0){
ID_Pos_Jump_Location location = {};
if (get_jump_from_list(app, list, list_index, &location)){
Buffer_Summary buffer = {};
if (get_jump_buffer(app, &buffer, &location)){
change_active_panel(app);
View_Summary target_view = get_active_view(app, AccessAll);
switch_to_existing_view(app, &target_view, &buffer);
jump_to_location(app, &target_view, &buffer, location);
}
}
}
end_temp_memory(temp);
}
CUSTOM_COMMAND_SIG(goto_jump_at_cursor_same_panel_sticky)
CUSTOM_DOC("If the cursor is found to be on a jump location, parses the jump location and brings up the file and position in this view, losing the compilation output or jump list.")
{
Heap *heap = &global_heap;
Partition *part = &global_part;
Temp_Memory temp = begin_temp_memory(part);
View_Summary view = get_active_view(app, AccessProtected);
Marker_List *list = get_or_make_list_for_buffer(app, part, heap, view.buffer_id);
i32 list_index = get_index_exact_from_list(app, part, list, view.cursor.line);
if (list_index >= 0){
ID_Pos_Jump_Location location = {};
if (get_jump_from_list(app, list, list_index, &location)){
Buffer_Summary buffer = {};
if (get_jump_buffer(app, &buffer, &location)){
View_Summary target_view = view;
jump_to_location(app, &target_view, &buffer, location);
}
}
}
end_temp_memory(temp);
}
static void
goto_jump_in_order(Application_Links *app, Marker_List *list, View_Summary *jump_view, ID_Pos_Jump_Location location){
Buffer_Summary buffer = {};
if (get_jump_buffer(app, &buffer, &location)){
View_Summary target_view = get_active_view(app, AccessAll);
if (target_view.view_id == jump_view->view_id){
change_active_panel(app);
target_view = get_active_view(app, AccessAll);
}
switch_to_existing_view(app, &target_view, &buffer);
jump_to_location(app, &target_view, &buffer, location);
prev_location.buffer_id = location.buffer_id;
prev_location.line = location.pos;
prev_location.column = 0;
}
}
static b32
jump_is_repeat(ID_Line_Column_Jump_Location prev, ID_Pos_Jump_Location location){
b32 skip = false;
// NOTE(allen): This looks wrong, but it is correct. The prev_location is a line column type
// because that is how the old-style direct jumps worked, and they are still supported. All code paths
// in the sticky jump system treat line as the field for pos and ignore column. When the time has
// passed and the direct jump legacy system is gone then this can be corrected.
if (prev.buffer_id == location.buffer_id && prev.line == location.pos){
skip = true;
}
return(skip);
}
static void
goto_next_filtered_jump(Application_Links *app, Marker_List *list, View_Summary *jump_view, i32 list_index, i32 direction, b32 skip_repeats, b32 skip_sub_errors){
Assert(direction == 1 || direction == -1);
if (list != 0){
for (;list_index >= 0 && list_index < list->jump_count;){
ID_Pos_Jump_Location location = {};
if (get_jump_from_list(app, list, list_index, &location)){
b32 skip_this = false;
if (skip_repeats && jump_is_repeat(prev_location, location)){
skip_this = true;
}
else if (skip_sub_errors && get_is_sub_error_from_list(app, list, list_index)){
skip_this = true;
}
if (!skip_this){
goto_jump_in_order(app, list, jump_view, location);
i32 updated_line = get_line_from_list(app, list, list_index);
view_set_cursor(app, jump_view, seek_line_char(updated_line, 1), true);
break;
}
}
list_index += direction;
}
}
}
static Locked_Jump_State
get_locked_jump_state(Application_Links *app, Partition *part, Heap *heap){
Locked_Jump_State result = {};
result.view = get_view_for_locked_jump_buffer(app);
if (result.view.exists){
result.list = get_or_make_list_for_buffer(app, part, heap, result.view.buffer_id);
result.list_index = get_index_nearest_from_list(app, part, result.list, result.view.cursor.line);
}
return(result);
}
CUSTOM_COMMAND_SIG(goto_next_jump_sticky)
CUSTOM_DOC("If a buffer containing jump locations has been locked in, goes to the next jump in the buffer, skipping sub jump locations.")
{
Heap *heap = &global_heap;
Partition *part = &global_part;
Locked_Jump_State jump_state = get_locked_jump_state(app, part, heap);
if (jump_state.view.exists){
i32 line = get_line_from_list(app, jump_state.list, jump_state.list_index);
if (line <= jump_state.view.cursor.line){
++jump_state.list_index;
}
goto_next_filtered_jump(app, jump_state.list, &jump_state.view, jump_state.list_index, 1, true, true);
}
}
CUSTOM_COMMAND_SIG(goto_prev_jump_sticky)
CUSTOM_DOC("If a buffer containing jump locations has been locked in, goes to the previous jump in the buffer, skipping sub jump locations."){
Heap *heap = &global_heap;
Partition *part = &global_part;
Locked_Jump_State jump_state = get_locked_jump_state(app, part, heap);
if (jump_state.view.exists){
if (jump_state.list_index > 0){
--jump_state.list_index;
}
goto_next_filtered_jump(app, jump_state.list, &jump_state.view, jump_state.list_index, -1, true, true);
}
}
CUSTOM_COMMAND_SIG(goto_next_jump_no_skips_sticky)
CUSTOM_DOC("If a buffer containing jump locations has been locked in, goes to the next jump in the buffer, and does not skip sub jump locations.")
{
Heap *heap = &global_heap;
Partition *part = &global_part;
Locked_Jump_State jump_state = get_locked_jump_state(app, part, heap);
if (jump_state.view.exists){
i32 line = get_line_from_list(app, jump_state.list, jump_state.list_index);
if (line <= jump_state.view.cursor.line){
++jump_state.list_index;
}
goto_next_filtered_jump(app, jump_state.list, &jump_state.view, jump_state.list_index, 1, true, false);
}
}
CUSTOM_COMMAND_SIG(goto_prev_jump_no_skips_sticky)
CUSTOM_DOC("If a buffer containing jump locations has been locked in, goes to the previous jump in the buffer, and does not skip sub jump locations.")
{
Heap *heap = &global_heap;
Partition *part = &global_part;
Locked_Jump_State jump_state = get_locked_jump_state(app, part, heap);
if (jump_state.view.exists){
if (jump_state.list_index > 0){
--jump_state.list_index;
}
goto_next_filtered_jump(app, jump_state.list, &jump_state.view, jump_state.list_index, -1, true, false);
}
}
CUSTOM_COMMAND_SIG(goto_first_jump_sticky)
CUSTOM_DOC("If a buffer containing jump locations has been locked in, goes to the first jump in the buffer.")
{
Heap *heap = &global_heap;
Partition *part = &global_part;
Locked_Jump_State jump_state = get_locked_jump_state(app, part, heap);
if (jump_state.view.exists){
i32 list_index = 0;
ID_Pos_Jump_Location location = {};
if (get_jump_from_list(app, jump_state.list, list_index, &location)){
goto_jump_in_order(app, jump_state.list, &jump_state.view, location);
i32 updated_line = get_line_from_list(app, jump_state.list, list_index);
view_set_cursor(app, &jump_state.view, seek_line_char(updated_line, 1), true);
}
}
}
CUSTOM_COMMAND_SIG(goto_first_jump_same_panel_sticky)
CUSTOM_DOC("If a buffer containing jump locations has been locked in, goes to the first jump in the buffer and views the buffer in the panel where the jump list was.")
{
Heap *heap = &global_heap;
Partition *part = &global_part;
Locked_Jump_State jump_state = get_locked_jump_state(app, part, heap);
if (jump_state.view.exists){
i32 list_index = 0;
ID_Pos_Jump_Location location = {};
if (get_jump_from_list(app, jump_state.list, list_index, &location)){
Buffer_Summary buffer = {};
if (get_jump_buffer(app, &buffer, &location)){
jump_to_location(app, &jump_state.view, &buffer, location);
}
}
}
}
//
// Insert Newline or Tigger Jump on Read Only Buffer
//
CUSTOM_COMMAND_SIG(newline_or_goto_position_sticky)
CUSTOM_DOC("If the buffer in the active view is writable, inserts a character, otherwise performs goto_jump_at_cursor.")
{
View_Summary view = get_active_view(app, AccessProtected);
Buffer_Summary buffer = get_buffer(app, view.buffer_id, AccessProtected);
if (buffer.lock_flags & AccessProtected){
goto_jump_at_cursor_sticky(app);
lock_jump_buffer(buffer);
}
else{
write_character(app);
}
}
CUSTOM_COMMAND_SIG(newline_or_goto_position_same_panel_sticky)
CUSTOM_DOC("If the buffer in the active view is writable, inserts a character, otherwise performs goto_jump_at_cursor_same_panel.")
{
View_Summary view = get_active_view(app, AccessProtected);
Buffer_Summary buffer = get_buffer(app, view.buffer_id, AccessProtected);
if (buffer.lock_flags & AccessProtected){
goto_jump_at_cursor_same_panel_sticky(app);
lock_jump_buffer(buffer);
}
else{
write_character(app);
}
}
//
// End File Hook
//
OPEN_FILE_HOOK_SIG(default_end_file);
OPEN_FILE_HOOK_SIG(end_file_close_jump_list){
Marker_List *list = get_marker_list_for_buffer(buffer_id);
if (list != 0){
delete_marker_list(list);
}
default_end_file(app, buffer_id);
return(0);
}
// BOTTOM