( )⚙ D2685 xdiff: add comments for fields in xdfile_t

This is an archive of the discontinued Mercurial Phabricator instance.

Differential D2685

xdiff: add comments for fields in xdfile_t
ClosedPublic

Authored by quark on Mar 4 2018, 7:50 PM.

Details

Reviewers
indygreg
Group Reviewers
hg-reviewers
Commits
rHG0c7350656f93: xdiff: add comments for fields in xdfile_t
rHG58028f6d1fb8: xdiff: add comments for fields in xdfile_t
Summary

This makes the related code easier to understand.

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

quark created this revision.Mar 4 2018, 7:50 PM
quark abandoned this revision.Mar 4 2018, 8:09 PM

No longer needed

indygreg accepted this revision.Mar 9 2018, 6:16 PM
indygreg added a subscriber: indygreg.

So. Much. Better.

This revision is now accepted and ready to land.Mar 9 2018, 6:16 PM
Closed by commit rHG58028f6d1fb8: xdiff: add comments for fields in xdfile_t (authored by quark). · Explain WhyMar 9 2018, 6:24 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mmercurial/thirdparty/xdiff/xtypes.h (34 lines)

Diff 6805

mercurial/thirdparty/xdiff/xtypes.h

typedef struct s_xrecord { typedef struct s_xrecord {
struct s_xrecord *next; struct s_xrecord *next;
char const *ptr; char const *ptr;
long size; long size;
unsigned long ha; unsigned long ha;
} xrecord_t; } xrecord_t;
typedef struct s_xdfile { typedef struct s_xdfile {
/* manual memory management */
chastore_t rcha; chastore_t rcha;
/* number of records (lines) */
long nrec; long nrec;
/* hash table size
* the maximum hash value in the table is (1 << hbits) */
unsigned int hbits; unsigned int hbits;
/* hash table, hash value => xrecord_t
* note: xrecord_t is a linked list. */
xrecord_t **rhash; xrecord_t **rhash;
/* range excluding common prefix and suffix
* [recs[i] for i in range(0, dstart)] are common prefix.
* [recs[i] for i in range(dstart, dend + 1 - dstart)] are interesting
* lines */
long dstart, dend; long dstart, dend;
/* pointer to records (lines) */
xrecord_t **recs; xrecord_t **recs;
/* record changed, use original "recs" index
* rchag[i] can be either 0 or 1. 1 means recs[i] (line i) is marked
* "changed". */
char *rchg; char *rchg;
/* cleaned-up record index => original "recs" index
* clean-up means:
* rule 1. remove common prefix and suffix
* rule 2. remove records that are only on one side, since they can
* not match the other side
* rindex[0] is likely dstart, if not removed up by rule 2.
* rindex[nreff - 1] is likely dend, if not removed by rule 2.
*/
long *rindex; long *rindex;
/* rindex size */
long nreff; long nreff;
/* cleaned-up record index => hash value
* ha[i] = recs[rindex[i]]->ha */
unsigned long *ha; unsigned long *ha;
} xdfile_t; } xdfile_t;
typedef struct s_xdfenv { typedef struct s_xdfenv {
xdfile_t xdf1, xdf2; xdfile_t xdf1, xdf2;
/* number of lines for common prefix and suffix that are removed /* number of lines for common prefix and suffix that are removed
* from xdf1 and xdf2 as a preprocessing step */ * from xdf1 and xdf2 as a preprocessing step */
long nprefix, nsuffix; long nprefix, nsuffix;
} xdfenv_t; } xdfenv_t;
#endif /* #if !defined(XTYPES_H) */ #endif /* #if !defined(XTYPES_H) */