about summary refs log tree commit diff
path: root/line-range.h
diff options
context:
space:
mode:
Diffstat (limited to 'line-range.h')
-rw-r--r--line-range.h41
1 files changed, 41 insertions, 0 deletions
diff --git a/line-range.h b/line-range.h
new file mode 100644
index 000000000000..e69bf7c01765
--- /dev/null
+++ b/line-range.h
@@ -0,0 +1,41 @@
+#ifndef LINE_RANGE_H
+#define LINE_RANGE_H
+
+struct index_state;
+
+/*
+ * Parse one item in an -L begin,end option w.r.t. the notional file
+ * object 'cb_data' consisting of 'lines' lines.
+ *
+ * The 'nth_line_cb' callback is used to determine the start of the
+ * line 'lno' inside the 'cb_data'.  The caller is expected to already
+ * have a suitable map at hand to make this a constant-time lookup.
+ *
+ * 'anchor' is the 1-based line at which relative range specifications
+ * should be anchored. Absolute ranges are unaffected by this value.
+ *
+ * Returns 0 in case of success and -1 if there was an error.  The
+ * actual range is stored in *begin and *end.  The counting starts
+ * at 1!  In case of error, the caller should show usage message.
+ */
+
+typedef const char *(*nth_line_fn_t)(void *data, long lno);
+
+int parse_range_arg(const char *arg,
+		    nth_line_fn_t nth_line_cb,
+		    void *cb_data, long lines, long anchor,
+		    long *begin, long *end,
+		    const char *path, struct index_state *istate);
+
+/*
+ * Scan past a range argument that could be parsed by
+ * 'parse_range_arg', to help the caller determine the start of the
+ * filename in '-L n,m:file' syntax.
+ *
+ * Returns a pointer to the first character after the 'n,m' part, or
+ * NULL in case the argument is obviously malformed.
+ */
+
+const char *skip_range_arg(const char *arg, struct index_state *istate);
+
+#endif /* LINE_RANGE_H */