Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add highlight component #237

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
83 changes: 83 additions & 0 deletions static/highlight.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
// Copyright 2018 The Rustw Project Developers.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

import React from 'react';

export const Highlight = (props) => {
const src_line_prefix = 'src_line_';
const highlight = props.highlight;
const is_valid_highlight = validate_highlight(highlight);

if (!is_valid_highlight) {
return null;
}

const lhs = (highlight.column_start - 1);
const rhs = (highlight.column_end - 1);
const highlight_specs = make_highlight(src_line_prefix, highlight.line_start, lhs, rhs);
if (highlight_specs) {
const { top, left, width } = highlight_specs;
const style = {
top: top,
left: left,
width: width,
}
return <div className="selected floating_highlight" key={highlight.line_start} style={style}>&nbsp;</div>;
}

return null;
}

function make_highlight(src_line_prefix, line_number, left, right) {
const line_div = $("#" + src_line_prefix + line_number);

// TODO: get adjust variable as prop through diffIndent in FileResult
// if Highlight component is to be used in the SearchResults component
// const adjust = line_div.data('adjust');
// if (adjust) {
// left -= adjust;
// right -= adjust;
// }

left *= CHAR_WIDTH;
right *= CHAR_WIDTH;
if (right === 0) {
right = line_div.width();
}

let width = right - left;
const paddingLeft = parseInt(line_div.css("padding-left"));
const paddingTop = parseInt(line_div.css("padding-top"));
if (left >= 0) {
left -= paddingLeft;
} else {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nrc since the position is now calculated differently, I adjusted the conditional for the left padding subtraction to check for left >=0 rather than left > 0. Do you know if there would ever be a case where left is less than zero, or could I remove the else here?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We call it here: https://github.com/nrc/cargo-src/pull/237/files/ac2f86ab6bc765177f3e12af715b890c5de80476#diff-4018adfb8de39d7a30dd31dd44e3b4cdR22 and lhs is highlight.column - 1, so I think that should always be greater than 0 since the column should be 1-indexed, but we might want to check that it really is 1-indexed, not 0-indexed, and that seems like an easy mistake to make so it might be worth asserting that highlight.column >= 1 there.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found a case when testing a full-line highlight where lhs ends up being 0, and without changing the left > 0 (as it is in utils.js) to left >= 0, the highlight calculation is off slightly. But it sounds like we could just adjust the validate_highlight function to ensure highlight.column_start is not <= 1 rather than 0, as it is currently?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@nrc Ok, I'm re-thinking my previous comment - I think the validate_highlight logic can be left as-is, but the conditional adjustment in make_highlight could be reduced to left -= paddingLeft, with no check for left >= 0 or any else clause. At least that's working for the test cases I've been running through.

width += paddingLeft;
}

const position = line_div.position();
if (position) {
position.left += left;
position.top += paddingTop;
return { top: position.top, left: position.left, width };
}
// If no position, don't render the highlight
return null;
}

// TODO: this could maybe be validated in app.js, at srcHighlight declaration
function validate_highlight(highlight) {
const required_keys = ['line_start', 'line_end', 'column_start', 'column_end'];
const has_keys = required_keys.reduce((acc, k) => {
return acc && highlight[k] !== undefined;
}, true);

if (!has_keys || highlight.column_start <= 0) {
return false;
}
return true;
}
Loading