[overlay] tweak the File: line

Author: tstack

NEWS.md

@@ -38,8 +38,17 @@ Features:
     BACKSPACE and DELETE.
   - `CTRL-t` transposes the two characters before
     the cursor.
+* In the log message details (opened by pressing `p`),
+  a `File:` row has been added that lists the file and
+  line number the log message is from.  Also, for JSON
+  logs, you can focus on the `JSON fields:` row and
+  press `c` to copy the raw log message to the
+  clipboard.
 * The `measure_with_units` collator now recognizes
   (KiB, MiB, ...).
+* Added `disfavors` to `external-editor` configuration
+  to express file names that the editor is not interested
+  in handling.
 
 Breaking changes:
 * The `humanize_file_size()` SQLite function now

README.md

@@ -47,7 +47,7 @@ however, they do not understand log messages.  Tail can watch
 multiple files at a time, but it won't display messages in order by
 time and you can't scroll backwards.  Grep will only find matching
 lines, but won't return a full multi-line log message.  Less can only
-display a single file at a time.  Also, none of these basic tools 
+display a single file at a time.  Also, none of these basic tools
 handle compressed files.
 
 ## Try online before installing
@@ -59,7 +59,7 @@ an example:
 
 [`$ ssh playground@demo.lnav.org`](ssh://playground@demo.lnav.org)
 
-The "tutorial 1" account is an interactive tutorial that can teach 
+The "tutorial 1" account is an interactive tutorial that can teach
 you the basics of operation:
 
 [`$ ssh tutorial1@demo.lnav.org`](ssh://tutorial1@demo.lnav.org)
@@ -89,17 +89,17 @@ monitor, it will figure out the rest:
 $ lnav /path/to/file1 /path/to/dir ...
 ```
 
-The **lnav** TUI will pop up right away and begin indexing the 
-files. Progress is displayed in the "Files" panel at the 
-bottom. Once the indexing has finished, the LOG view will display 
-the log messages that were recognized[^1]. You can then use the 
+The **lnav** TUI will pop up right away and begin indexing the
+files. Progress is displayed in the "Files" panel at the
+bottom. Once the indexing has finished, the LOG view will display
+the log messages that were recognized[^1]. You can then use the
 usual hotkeys to move around the view (arrow keys or
 `j`/`k`/`h`/`l` to move down/up/left/right).
 
 See the [Usage section](https://docs.lnav.org/en/latest/usage.html)
 of the online documentation for more information.
 
-[^1]: Files that do not contain log messages can be seen in the 
+[^1]: Files that do not contain log messages can be seen in the
       TEXT view (reachable by pressing `t`).
 
 ### Usage with `systemd-journald`

docs/schemas/config-v1.schema.json

@@ -325,6 +325,15 @@
                                         },
                                         "prefers": {
                                             "title": "/tuning/external-editor/impls/<editor_impl_name>/prefers",
+                                            "description": "Regular expression that matches file names preferred by this editor",
+                                            "type": "string",
+                                            "examples": [
+                                                "^.*(?:\\.cpp)$"
+                                            ]
+                                        },
+                                        "disfavors": {
+                                            "title": "/tuning/external-editor/impls/<editor_impl_name>/disfavors",
+                                            "description": "Regular expression that matches file names not favored by this editor",
                                             "type": "string",
                                             "examples": [
                                                 "^.*(?:\\.cpp)$"

src/column_namer.cc

@@ -110,11 +110,13 @@ column_namer::add_column(const string_fragment& in_name)
 
         fmt::format_to(
             std::back_inserter(buf), FMT_STRING("{}_{}"), base_name, num);
+#if 0
         log_trace("column name already exists (%.*s), trying (%.*s)",
                   retval.length(),
                   retval.data(),
                   (int) buf.size(),
                   buf.data());
+#endif
         retval = string_fragment::from_memory_buffer(buf);
         num += 1;
     }

src/external_editor.cc

@@ -80,7 +80,8 @@ get_config_dir_mtime(const std::filesystem::path& path,
             return retval;
         }
 
-        for (const auto& sib : std::filesystem::directory_iterator(parent)) {
+        for (const auto& sib : std::filesystem::directory_iterator(parent, ec))
+        {
             if (!sib.is_directory()) {
                 continue;
             }
@@ -110,7 +111,7 @@ static std::optional<std::string>
 get_impl(const std::filesystem::path& path)
 {
     const auto& cfg = injector::get<const config&>();
-    std::vector<std::tuple<time64_t, bool, const impl*>> candidates;
+    std::vector<std::tuple<time64_t, bool, bool, const impl*>> candidates;
 
     log_debug("editor impl count: %zu", cfg.c_impls.size());
     for (const auto& [name, impl] : cfg.c_impls) {
@@ -127,25 +128,60 @@ get_impl(const std::filesystem::path& path)
                       .ignore_error()
                       .has_value()
                 : false;
+            auto disfavors = impl.i_disfavors.pp_value
+                ? impl.i_disfavors.pp_value->find_in(path.string())
+                      .ignore_error()
+                      .has_value()
+                : false;
+            auto config_dir_mtime
+                = get_config_dir_mtime(path, impl.i_config_dir);
+            log_info("    config-dir-mtime: %llu, prefers: %s, disfavors: %s",
+                     config_dir_mtime,
+                     prefers ? "yes" : "no",
+                     disfavors ? "yes" : "no");
             candidates.emplace_back(
-                get_config_dir_mtime(path, impl.i_config_dir), prefers, &impl);
+                config_dir_mtime, prefers, disfavors, &impl);
         }
     }
 
     std::sort(candidates.begin(),
               candidates.end(),
               [](const auto& lhs, const auto& rhs) {
-                  const auto& [lmtime, lprefers, limpl] = lhs;
-                  const auto& [rmtime, rprefers, rimpl] = rhs;
+                  const auto& [lmtime, lprefers, ldisfavors, limpl] = lhs;
+                  const auto& [rmtime, rprefers, rdisfavors, rimpl] = rhs;
+
+                  if (lmtime > rmtime) {
+                      return true;
+                  }
+
+                  if (lmtime < rmtime) {
+                      return false;
+                  }
+
+                  if (lprefers && !rprefers) {
+                      return true;
+                  }
+
+                  if (!lprefers && rprefers) {
+                      return false;
+                  }
+
+                  if (ldisfavors && !rdisfavors) {
+                      return false;
+                  }
+
+                  if (!ldisfavors && rdisfavors) {
+                      return true;
+                  }
 
-                  return lmtime > rmtime || (lmtime == rmtime && lprefers);
+                  return limpl->i_command < rimpl->i_command;
               });
 
     if (candidates.empty()) {
         return std::nullopt;
     }
 
-    return std::get<2>(candidates.front())->i_command;
+    return std::get<3>(candidates.front())->i_command;
 }
 
 Result<void, std::string>

src/external_editor.cfg.hh

@@ -46,6 +46,7 @@ struct impl {
     std::string i_command;
     std::filesystem::path i_config_dir;
     factory_container<lnav::pcre2pp::code> i_prefers;
+    factory_container<lnav::pcre2pp::code> i_disfavors;
 };
 
 struct config {

src/field_overlay_source.cc

@@ -325,15 +325,31 @@ field_overlay_source::build_field_lines(const listview_curses& lv,
     }
 
     {
-        const auto& filename
-            = this->fos_log_helper.ldh_file->get_filename_as_string();
-        auto file_al = attr_line_t(" ")
-                           .append("File:"_h2)
-                           .pad_to(15)
-                           .append(lnav::roles::file(filename));
-
-        this->fos_row_to_field_meta.emplace(this->fos_lines.size(),
-                                            row_info{std::nullopt, filename});
+        const auto& actual_path
+            = this->fos_log_helper.ldh_file->get_actual_path();
+        const auto& filename = actual_path
+            ? actual_path->string()
+            : this->fos_log_helper.ldh_file->get_filename_as_string();
+        auto file_line_number
+            = fmt::to_string(this->fos_log_helper.ldh_file->get_line_number(
+                this->fos_log_helper.ldh_line));
+        auto file_link
+            = attr_line_t()
+                  .append(lnav::roles::file(filename))
+                  .append(":")
+                  .append(lnav::roles::number(file_line_number))
+                  .with_attr_for_all(VC_ROLE.value(role_t::VCR_HYPERLINK))
+                  .with_attr_for_all(VC_HYPERLINK.value(
+                      fmt::format(FMT_STRING("file://{}#L{}"),
+                                  filename,
+                                  file_line_number)));
+        auto file_al
+            = attr_line_t(" ").append("File:"_h2).pad_to(15).append(file_link);
+
+        auto file_line_pair
+            = fmt::format(FMT_STRING("{}:{}"), filename, file_line_number);
+        this->fos_row_to_field_meta.emplace(
+            this->fos_lines.size(), row_info{std::nullopt, file_line_pair});
         this->fos_lines.emplace_back(file_al);
     }
 
@@ -558,7 +574,19 @@ field_overlay_source::build_field_lines(const listview_curses& lv,
     if (!this->fos_log_helper.ldh_extra_json.empty()
         || !this->fos_log_helper.ldh_json_pairs.empty())
     {
-        this->fos_lines.emplace_back(" JSON fields:");
+        auto read_res = this->fos_log_helper.ldh_file->read_raw_message(
+            this->fos_log_helper.ldh_line);
+        if (read_res.isOk()) {
+            auto sbr = read_res.unwrap();
+            this->fos_row_to_field_meta.emplace(this->fos_lines.size(),
+                                                row_info{
+                                                    std::nullopt,
+                                                    to_string(sbr),
+                                                });
+        }
+        this->fos_lines.emplace_back(
+            attr_line_t(" JSON fields: ")
+                .append("(press 'c' to copy raw JSON log message)"_comment));
     }
 
     for (const auto& extra_pair : this->fos_log_helper.ldh_extra_json) {

src/lnav_config.cc

@@ -1134,7 +1134,8 @@ static const struct json_path_container theme_status_styles_handlers = {
         .for_child(&lnav_theme::lt_style_status_title)
         .with_children(style_config_handlers),
     yajlpp::property_handler("alert-title")
-        .with_description("Styling for title sections of status bars with alerts")
+        .with_description(
+            "Styling for title sections of status bars with alerts")
         .for_child(&lnav_theme::lt_style_status_alert_title)
         .with_children(style_config_handlers),
     yajlpp::property_handler("disabled-title")
@@ -1664,9 +1665,15 @@ static const json_path_container editor_impl_handlers = {
         .with_example(".idea"_frag)
         .for_field(&lnav::external_editor::impl::i_config_dir),
     yajlpp::property_handler("prefers")
-        .with_description("")
+        .with_description("Regular expression that matches file names "
+                          "preferred by this editor")
         .with_example("^.*(?:\\.cpp)$"_frag)
         .for_field(&lnav::external_editor::impl::i_prefers),
+    yajlpp::property_handler("disfavors")
+        .with_description("Regular expression that matches file names not "
+                          "favored by this editor")
+        .with_example("^.*(?:\\.cpp)$"_frag)
+        .for_field(&lnav::external_editor::impl::i_disfavors),
 };
 
 static const json_path_container editor_impls_handlers = {

src/logfile.cc

@@ -2111,6 +2111,24 @@ logfile::read_range(const file_range& fr)
     return this->lf_line_buffer.read_range(fr);
 }
 
+size_t
+logfile::get_line_number(const_iterator ll) const
+{
+    size_t retval = 1;
+
+    if (this->lf_format != nullptr && this->lf_format->lf_formatted_lines) {
+        for (auto iter = this->begin(); iter != ll; ++iter) {
+            if (iter->get_sub_offset() == 0) {
+                retval += 1;
+            }
+        }
+    } else {
+        retval += std::distance(this->begin(), ll);
+    }
+
+    return retval;
+}
+
 void
 logfile::read_full_message(const_iterator ll,
                            shared_buffer_ref& msg_out,

src/logfile.hh

@@ -357,6 +357,8 @@ public:
         return ll->get_offset() + (this->lf_line_buffer.is_piper() ? 22 : 0);
     }
 
+    size_t get_line_number(const_iterator ll) const;
+
     void read_full_message(const_iterator ll,
                            shared_buffer_ref& msg_out,
                            line_buffer::scan_direction dir