github_mirrors/vectorscan
3
0
Fork 1
mirror of https://github.com/VectorCamp/vectorscan.git synced 2025-07-13 14:04:44 +03:00
Code Issues Packages Projects Releases Wiki Activity

more comments on hwlm/fdr's start parameter

Browse Source
This commit is contained in:
Alex Coyte 2017-07-28 14:32:55 +10:00 committed by Matthew Barr
parent 56ec2dfc4a
commit 41783fe912
2 changed files with 6 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
src/fdr/fdr.h
View File

@ -50,7 +50,7 @@ struct hs_scratch;
* \param fdr FDR matcher engine. * \param fdr FDR matcher engine.
* \param buf Buffer to scan. * \param buf Buffer to scan.
* \param len Length of buffer to scan. * \param len Length of buffer to scan.
* \param start First offset in buf at which a match may end. * \param start First offset in buf at which a match may start.
* \param cb Callback to call when a match is found. * \param cb Callback to call when a match is found.
* \param scratch Scratch supplied to callback on match. * \param scratch Scratch supplied to callback on match.
* \param groups Initial groups mask. * \param groups Initial groups mask.
@ -67,7 +67,7 @@ hwlm_error_t fdrExec(const struct FDR *fdr, const u8 *buf, size_t len,
* \param hlen Length of history buffer (hbuf). * \param hlen Length of history buffer (hbuf).
* \param buf Buffer to scan. * \param buf Buffer to scan.
* \param len Length of buffer to scan (buf). * \param len Length of buffer to scan (buf).
* \param start First offset in buf at which a match may end. * \param start First offset in buf at which a match may start.
* \param cb Callback to call when a match is found. * \param cb Callback to call when a match is found.
* \param scratch Scratch supplied to callback on match. * \param scratch Scratch supplied to callback on match.
* \param groups Initial groups mask. * \param groups Initial groups mask.

6
src/hwlm/hwlm.h
View File

@ -107,7 +107,8 @@ typedef hwlmcb_rv_t (*HWLMCallback)(size_t end, u32 id,
* Returns \ref HWLM_TERMINATED if scanning is cancelled due to the callback * Returns \ref HWLM_TERMINATED if scanning is cancelled due to the callback
* returning \ref HWLM_TERMINATE_MATCHING. * returning \ref HWLM_TERMINATE_MATCHING.
* *
* \p start is the first offset at which a match may start. * \p start is the first offset at which a match may start. Note: match
* starts may include masks overhanging the main literal.
* *
* The underlying engine may choose not to report any match which starts before * The underlying engine may choose not to report any match which starts before
* the first possible match of a literal which is in the initial group mask. * the first possible match of a literal which is in the initial group mask.
@ -121,7 +122,8 @@ hwlm_error_t hwlmExec(const struct HWLM *tab, const u8 *buf, size_t len,
* \p len is the length of the main buffer to be scanned. * \p len is the length of the main buffer to be scanned.
* *
* \p start is an advisory hint representing the first offset at which a match * \p start is an advisory hint representing the first offset at which a match
* may start. Some underlying literal matches may not respect it. * may start. Some underlying literal matches may not respect it. Note: match
* starts may include masks overhanging the main literal.
* *
* \p scratch is used to access the history buffer, history length and * \p scratch is used to access the history buffer, history length and
* the main buffer. * the main buffer.