Explore how to open the bug guide in a small window

[mdoron]

Introduction task which both me and @yosefraisman think is a good idea. The idea is just like the help in MATLAB open a small window, I want our site would open this way in the plugin.

[mdoron]

I've managed to do so, but I think it doesn't look good. I'm trying to do it with quick fix-like interface (similar to the Tippers in Spartan project).

[mdoron]

We can now suggests fixes with the proper GUI (I left an example within SendTrace.java). Next step is actually allowing fixes in code.

[mdoron]

In second thought, I want to see if I can improve this a little bit. I will keep this open for now.

[yonzarecki]

@mdoron are you still working on this issue ?

93

[mdoron]

@yonzarecki Yes but now this goes under research again, correspondingly to what was discussed with Yosi.

[yonzarecki]

👍

[mdoron]

So, short summary + update: At the beginning I thought we should add a small window to the eclipse plugin which will hold a simple explanation from the server about the cause for the bug we have. I wanted it to be over the lines which caused the exception. So the first lead was to implement something like we have in the Spartanizer project, using IMarkers etc. I implemented something simple to check if it's working and it was nice, but not enough. Then, @yossigil offered we won't use the markers, but something else, since this is not the right way to do such explanations. I searched a little bit and realized we should implement a Hover Help. So this is what I'm working on now - trying to understand how to do it the right way and add it to the project.

Update: I've decided to go deeper because I don't feel like I understand the core of eclipse plug-in dev. I have also looked on the internet and found some interesting material, but I will dive into those only after I'll feel comfortable with plug-in dev.

• [x] Explore the Platform Plug-in Developer Guide
• [x] Explore relevant material for hover help
• [x] Implement a simple prototype - only of the hover help.
• [x] Create an issue: "Implementing Plug-in side Hover Help"

[mdoron]

English will follow

סיכום מחקר

מטרת הרעיון

לקבל stack-trace, ובקבצים המתאימים בשורות המתאימות להניח הודעת המלצה מהשרת לגבי השגיאה. המחקר בוצע כדי לקבל הערכה כיצד לממש בצד הפלאגין.

תיאור המחקר

בתחילה חקרתי את נושא ה markerים והצלחתי לקבל מספר שורה (אפילו בהתאם לשגיאה שקיבלנו למרות שהנושא הזה לא פותח במלואו בעקבות דברים אחרים) ולהציג עליה הודעת שגיאה. לאחר מכן בעקבות השיחה עם המנחה הגענו למסקנה שה markerים במקורם מיועדים למנגנון של quickfix והוא לא המנגנון המדויק שאנחנו רוצים, כי הוא מיועד יותר לממש תיקון בקוד, דבר שאנחנו לא עושים. בעקבות כך פניתי למחקר של hover text לעומק כ lead מרכזי, וגיליתי שבמנגנון שם מה שקורה זה שאם מציבים את הסמן על איזשהו region אנחנו יכולים לקבל אותו ואז לבצע משהו. שמתי לב שאנחנו מצד אחד רוצים לקבל את ההתנהגות של marker שאפשר לסמן מקומות מסויימים ועליהם לקבל איזשהו מטה-דטה, ומצד שני לא לאפשר באמת מצב של quick fix. לא מצאתי מנגנון אחר שמשלב בין השניים.

תוצאות ביניים ומסקנות

• הצלחתי לגרום לשני החלקים לעבוד בנפרד כאבי-טיפוס.
• אחרי מחקר מעמיק יחסית הגעתי למסקנה שלא קיים באקליפס מנגנון שמתאים לנו באופן ישיר. חקרתי את הנושא והגעתי למסקנה שצריך לחשוב על דרך שלא נמצאת בצורה ישירה באקליפס לחבר בין שני המנגנונים הללו (quickfix+hover text), כלומר ליצור איזשהו מנגנון עוטף.
• לחלופין, אפשר לממש הכל דרך מנגנון ה quickfix באמצעות Errors, מה שיהיה קל יותר, ולהתפשר על כך שזה לא היעוד המקורי שלו ולא נוכל (ככל הנראה) להשתמש בעיצוב ההודעה.

  הצעות וצעדים להמשך

• יש להתייעץ עם המנחה @yossigil לגבי המנגנון הנכון לביצוע המטלה.
• יש להתייעץ עם הלקוח @AdiOmari, להציג לו את המחקר, ולבדוק האם הדבר מספיק חשוב לו כדי שנשקיע זמן על פיתוח מנגנון עוטף או שהוא היה רוצה לראות דברים נוספים בפלאגין, ואפשר להתפשר על הפתרון השני.

Research Summary

Idea's Goal

Get a stack-trace, and in the suitable files, in the suitable lines, put a message from the server regarding the exception. The research was done in order to get an estimation regarding the best way to implement it in the plug-in side

Research Description

At first, I researched the Markers and succeed to get a line number and to put a message on it using the Markers. Afterwards, after a conversation with the instructor, we've reached the idea that the Markers are not intended for such cause, because we actually want to change code when we use them, so quickfix is not the precise mechanism we want to use. As a result a turned to research the Hover Text as main lead and I've discovered that in that mechanism you put your cursor on some Region and then we can get it and display a message. I've noticed that on one side we want the behavior of a Marker, and on the other side we don't want to actually enable a state a quickfix - in thus we want the Hover Text mechanism. I didn't find a mechanism that combine the best of both worlds.

Intermediate Results and Consequences

• I've managed to make both parts word separately as prototypes
• After deep research I've reached the conclusion that there is not such mechanism in Eclipse that fits us precisely. I've investigated the topic and reached the idea that we have to think of a way which is not directly lies in Eclipse in order to combine both mechanisms (quickfix + hover text), that is, to create a wrapping mechanism.
• Alternatively, we can implement everything through the quickfix mechanism using Errors. That would be easier but requires us to compromise on the fact that this is not this mechanism original goal, and we won't be able to generate nice HTML formatted messages to the user (probably).

  Suggestions

• We should consult our instructor regarding the right mechanism best to perform the task.
• We should consult our costumer, present the research, and test if this is important enough for him for us to invest time on developing a wrapping mechanism, or maybe he wants us to continue and do other things in the plug-in, and therefore we can compromise on the second solution.

[yonzarecki]

I'd say this issue is finished, isn't it ? @mdoron

[mdoron]

Definitely.