| 1 | package App::Codit::Plugins::Bookmarks; | ||
| 2 | |||
| 3 | =head1 NAME | ||
| 4 | |||
| 5 | App::Codit::Plugins::Bookmarks - plugin for App::Codit | ||
| 6 | |||
| 7 | =cut | ||
| 8 | |||
| 9 | use strict; | ||
| 10 | use warnings; | ||
| 11 | use vars qw( $VERSION ); | ||
| 12 | $VERSION = '0.21'; | ||
| 13 | |||
| 14 | use Data::Compare; | ||
| 15 | require Tk::ITree; | ||
| 16 | |||
| 17 | use base qw( App::Codit::BaseClasses::TextModPlugin ); | ||
| 18 | |||
| 19 | =head1 DESCRIPTION | ||
| 20 | |||
| 21 | Manage bookmarks for all files. | ||
| 22 | |||
| 23 | =head1 DETAILS | ||
| 24 | |||
| 25 | The bookmarks menu only covers bookmarks within the selected document. The bookmarks | ||
| 26 | plugin covers the bookmarks in all open files. I creates a bookmarks list in the | ||
| 27 | navigator panel and a previous and next button in the toolbar. Previous and next refer | ||
| 28 | to the previously and next selected bookmarks. | ||
| 29 | |||
| 30 | The sessions plugin restores all bookmarks in the Bookmarks plugin if it is loaded. | ||
| 31 | |||
| 32 | =head1 COMMANDS | ||
| 33 | |||
| 34 | =over 4 | ||
| 35 | |||
| 36 | =item B<bm_plug_next> | ||
| 37 | |||
| 38 | Jumps to the next selected bookmark. | ||
| 39 | |||
| 40 | =item B<bm_plug_previous> | ||
| 41 | |||
| 42 | Jumps to the previous selected bookmark. | ||
| 43 | |||
| 44 | =back | ||
| 45 | |||
| 46 | =cut | ||
| 47 | |||
| 48 | sub new { | ||
| 49 | my $class = shift; | ||
| 50 | my $self = $class->SUPER::new(@_); | ||
| 51 | return undef unless defined $self; | ||
| 52 | |||
| 53 | my $page = $self->ToolLeftPageAdd('Bookmarks', 'bookmarks', undef, 'Manage your bookmarks', 250); | ||
| 54 | |||
| 55 | $self->cmdConfig( | ||
| 56 | bm_plug_next => ['bmNext', $self], | ||
| 57 | bm_plug_previous => ['bmPrevious', $self], | ||
| 58 | ); | ||
| 59 | $self->cmdHookAfter('bookmark_add', 'RefreshSelected', $self); | ||
| 60 | $self->cmdHookAfter('bookmark_remove', 'RefreshSelected', $self); | ||
| 61 | |||
| 62 | $self->{CURRENT} = undef; | ||
| 63 | $self->{NEXT} = []; | ||
| 64 | $self->{PREVIOUS} = []; | ||
| 65 | |||
| 66 | my $tree = $page->Scrolled('ITree', | ||
| 67 | -height => 4, | ||
| 68 | -browsecmd => ['Select', $self], | ||
| 69 | -scrollbars => 'osoe', | ||
| 70 | -separator => '@', | ||
| 71 | )->pack(-padx => 2, -pady => 2, -expand => 1, -fill => 'both'); | ||
| 72 | $self->{TREE} = $tree; | ||
| 73 | |||
| 74 | $self->after(100, ['Initialize', $self]); | ||
| 75 | return $self; | ||
| 76 | } | ||
| 77 | |||
| 78 | sub _visible { | ||
| 79 | my $self = shift; | ||
| 80 | return $self->tree->ismapped; | ||
| 81 | } | ||
| 82 | |||
| 83 | sub bmAdd { | ||
| 84 | my $self = shift; | ||
| 85 | my $name = shift; | ||
| 86 | my $t = $self->tree; | ||
| 87 | |||
| 88 | #add parent unless already exists | ||
| 89 | unless ($t->infoExists($name)) { | ||
| 90 | |||
| 91 | #calculate position | ||
| 92 | my @ch = $t->infoChildren(''); | ||
| 93 | my @op; | ||
| 94 | for (@ch) { | ||
| 95 | if ($_ gt $name) { | ||
| 96 | push @op, -before => $_; | ||
| 97 | last; | ||
| 98 | } | ||
| 99 | } | ||
| 100 | |||
| 101 | #add parent | ||
| 102 | $t->add($name, -text => $self->abbreviate($name, 30), @op); | ||
| 103 | } | ||
| 104 | |||
| 105 | #add bookmarks | ||
| 106 | while (@_) { | ||
| 107 | my $mark = shift; | ||
| 108 | unless ($self->bmExists($name, $mark)) { | ||
| 109 | #calculate position | ||
| 110 | my @ch = $t->infoChildren($name); | ||
| 111 | my $text = $mark; | ||
| 112 | $mark =~ s/\@/_/g; | ||
| 113 | my $newmark = $name . '@' . $mark; | ||
| 114 | my $line = $self->bmLineNumber($newmark); | ||
| 115 | my @op; | ||
| 116 | for (@ch) { | ||
| 117 | my $peer = $self->bmLineNumber($_); | ||
| 118 | if ($peer > $line) { | ||
| 119 | push @op, -before => $_; | ||
| 120 | last; | ||
| 121 | } | ||
| 122 | } | ||
| 123 | |||
| 124 | #add bookmark | ||
| 125 | print "bookmark $newmark\n"; | ||
| 126 | $t->add($newmark, -text => $text, @op); | ||
| 127 | } | ||
| 128 | $t->autosetmode(1); | ||
| 129 | } | ||
| 130 | } | ||
| 131 | |||
| 132 | sub bmCompare { | ||
| 133 | my ($self, $mark1, $mark2) = @_; | ||
| 134 | if ($mark1 =~ /^(\d+)/) { | ||
| 135 | $mark1 = $1 | ||
| 136 | } | ||
| 137 | if ($mark2 =~ /^(\d+)/) { | ||
| 138 | $mark2 = $1 | ||
| 139 | } | ||
| 140 | return $mark1 eq $mark2 | ||
| 141 | } | ||
| 142 | |||
| 143 | sub bmExists { | ||
| 144 | my ($self, $name, $mark) = @_; | ||
| 145 | my $t = $self->tree; | ||
| 146 | return '' unless $t->infoExists($name); | ||
| 147 | |||
| 148 | my @list = $t->infoChildren($name); | ||
| 149 | for (@list) { | ||
| 150 | my @targ = split/\@/, $_; | ||
| 151 | return 1 if $self->bmCompare($mark, $targ[1]); | ||
| 152 | } | ||
| 153 | return '' | ||
| 154 | } | ||
| 155 | |||
| 156 | sub bmGo { | ||
| 157 | my ($self, $mark) = @_; | ||
| 158 | my ($doc, $bm) = split /\@/, $mark; | ||
| 159 | $bm = '' unless defined $bm; | ||
| 160 | my $mdi = $self->mdi; | ||
| 161 | if ($bm =~ /^(\d+)/) { | ||
| 162 | $self->cmdExecute('doc_select', $doc); | ||
| 163 | my $w = $mdi->docGet($doc)->CWidg; | ||
| 164 | $w->bookmarkGo($1); | ||
| 165 | } | ||
| 166 | } | ||
| 167 | |||
| 168 | sub bmLineNumber { | ||
| 169 | my ($self, $mark) = @_; | ||
| 170 | my ($doc, $bm) = split /\@/, $mark; | ||
| 171 | $bm = '' unless defined $bm; | ||
| 172 | if ($bm =~ /^(\d+)/) { | ||
| 173 | return $1 | ||
| 174 | } | ||
| 175 | } | ||
| 176 | |||
| 177 | sub bmNext { | ||
| 178 | my $self = shift; | ||
| 179 | my $nstack = $self->{NEXT}; | ||
| 180 | if (@$nstack) { | ||
| 181 | my $pstack = $self->{PREVIOUS}; | ||
| 182 | unshift @$pstack, $self->{CURRENT}; | ||
| 183 | my $new = shift @$nstack; | ||
| 184 | $self->{CURRENT} = $new; | ||
| 185 | $self->bmGo($new); | ||
| 186 | } | ||
| 187 | } | ||
| 188 | |||
| 189 | sub bmPrevious { | ||
| 190 | my $self = shift; | ||
| 191 | my $pstack = $self->{PREVIOUS}; | ||
| 192 | if (@$pstack) { | ||
| 193 | my $nstack = $self->{NEXT}; | ||
| 194 | unshift @$nstack, $self->{CURRENT}; | ||
| 195 | my $new = shift @$pstack; | ||
| 196 | $self->{CURRENT} = $new; | ||
| 197 | $self->bmGo($new); | ||
| 198 | } | ||
| 199 | } | ||
| 200 | |||
| 201 | sub Collect { | ||
| 202 | my ($self, $name) = @_; | ||
| 203 | # print "collecting $name\n"; | ||
| 204 | my @out = (); | ||
| 205 | my $mdi = $self->mdi; | ||
| 206 | if ($mdi->deferredExists($name)) { | ||
| 207 | my $o = $mdi->deferredOptions($name); | ||
| 208 | if (defined $o) { | ||
| 209 | if (my $b = $o->{'bookmarks'}) { | ||
| 210 | my @marks = (); | ||
| 211 | while ($b =~ s/^(\d+)\s//) { | ||
| 212 | push @marks, $1; | ||
| 213 | } | ||
| 214 | my $num = 1; | ||
| 215 | if (open IF, '<', $name) { | ||
| 216 | while (my $line = <IF>) { | ||
| 217 | chomp $line; | ||
| 218 | if ($num eq $marks[0]) { | ||
| 219 | shift @marks; | ||
| 220 | $line =~ s/^\s+//; | ||
| 221 | my $o = $line; | ||
| 222 | $o = substr($line, 0, 20) if length $line > 20; | ||
| 223 | push @out, "$num - $o"; | ||
| 224 | } | ||
| 225 | $num ++; | ||
| 226 | last unless @marks; | ||
| 227 | } | ||
| 228 | close IF; | ||
| 229 | } | ||
| 230 | } | ||
| 231 | } | ||
| 232 | } else { | ||
| 233 | my $w = $mdi->docGet($name)->CWidg; | ||
| 234 | my @list = $w->bookmarkList; | ||
| 235 | for (@list) { | ||
| 236 | push @out, "$_ - " . $w->bookmarkText($_); | ||
| 237 | } | ||
| 238 | } | ||
| 239 | return @out | ||
| 240 | } | ||
| 241 | |||
| 242 | sub docRefresh { | ||
| 243 | my ($self, $name) = @_; | ||
| 244 | my $t = $self->tree; | ||
| 245 | |||
| 246 | my $cursel; | ||
| 247 | ( $cursel ) = $t->infoSelection; | ||
| 248 | |||
| 249 | if ($t->infoExists($name)) { | ||
| 250 | for ($t->infoChildren($name)) { | ||
| 251 | $t->deleteEntry($_); | ||
| 252 | } | ||
| 253 | } | ||
| 254 | my @new = $self->Collect($name); | ||
| 255 | if ($t->infoExists($name)) { | ||
| 256 | $t->deleteEntry($name) unless @new; | ||
| 257 | } | ||
| 258 | $self->bmAdd($name, @new) if @new; | ||
| 259 | |||
| 260 | $t->selectionSet($cursel) if (defined $cursel) and $t->infoExists($cursel); | ||
| 261 | } | ||
| 262 | |||
| 263 | sub histClearNext { | ||
| 264 | my $self = shift; | ||
| 265 | $self->{NEXT} = []; | ||
| 266 | } | ||
| 267 | |||
| 268 | sub Initialize { | ||
| 269 | my $self = shift; | ||
| 270 | my $t = $self->tree; | ||
| 271 | $t->deleteAll; | ||
| 272 | my $mdi = $self->mdi; | ||
| 273 | for ($mdi->deferredList, $mdi->docList) { | ||
| 274 | my @marks = $self->Collect($_); | ||
| 275 | $self->bmAdd($_, @marks) if @marks; | ||
| 276 | } | ||
| 277 | } | ||
| 278 | |||
| 279 | sub Refresh { | ||
| 280 | my $self = shift; | ||
| 281 | $self->SUPER::Refresh; | ||
| 282 | $self->RefreshSelected; | ||
| 283 | } | ||
| 284 | |||
| 285 | sub RefreshAll { | ||
| 286 | my $self = shift; | ||
| 287 | my $t = $self->tree; | ||
| 288 | my @list = $t->infoChildren(''); | ||
| 289 | for (@list) { | ||
| 290 | $self->docRefresh($_); | ||
| 291 | } | ||
| 292 | } | ||
| 293 | |||
| 294 | sub RefreshSelected { | ||
| 295 | my $self = shift; | ||
| 296 | my $mdi = $self->extGet('CoditMDI'); | ||
| 297 | my $doc = $mdi->docSelected; | ||
| 298 | return unless defined $doc; | ||
| 299 | $self->docRefresh($doc); | ||
| 300 | } | ||
| 301 | |||
| 302 | sub Select { | ||
| 303 | my ($self, $mark) = @_; | ||
| 304 | |||
| 305 | #check if the mark is valid | ||
| 306 | my @targ = split /\@/, $mark; | ||
| 307 | return unless @targ eq 2; | ||
| 308 | |||
| 309 | #handle history | ||
| 310 | my $cur = $self->{CURRENT}; | ||
| 311 | if ((defined $cur) and ($cur ne $mark)) { | ||
| 312 | my $prev = $self->{PREVIOUS}; | ||
| 313 | push @$prev, $cur; | ||
| 314 | $self->histClearNext; | ||
| 315 | } | ||
| 316 | |||
| 317 | #jump to bookmark | ||
| 318 | $self->{CURRENT} = $mark; | ||
| 319 | $self->bmGo($mark); | ||
| 320 | } | ||
| 321 | |||
| 322 | sub tree { return $_[0]->{TREE} } | ||
| 323 | |||
| 324 | sub ToolItems { | ||
| 325 | my $self = shift; | ||
| 326 | my @items = $self->SUPER::ToolItems; | ||
| 327 | return (@items, | ||
| 328 | # type label cmd icon help | ||
| 329 | [ 'tool_separator' ], | ||
| 330 | [ 'tool_button', 'Previous', 'bm_plug_previous', 'bookmark_previous', 'Jump to previous bookmark'], | ||
| 331 | [ 'tool_button', 'Next', 'bm_plug_next', 'bookmark_next', 'Jump to next bookmark'], | ||
| 332 | ); | ||
| 333 | } | ||
| 334 | |||
| 335 | sub Unload { | ||
| 336 | my $self = shift; | ||
| 337 | for (qw/ | ||
| 338 | bm_plug_next | ||
| 339 | bm_plug_previous | ||
| 340 | /) { | ||
| 341 | $self->cmdRemove($_); | ||
| 342 | } | ||
| 343 | $self->cmdUnhookAfter('bookmark_add', 'RefreshSelected', $self); | ||
| 344 | $self->cmdUnhookAfter('bookmark_remove', 'RefreshSelected', $self); | ||
| 345 | $self->ToolLeftPageRemove('Bookmarks'); | ||
| 346 | return $self->SUPER::Unload; | ||
| 347 | } | ||
| 348 | |||
| 349 | =head1 LICENSE | ||
| 350 | |||
| 351 | Same as Perl. | ||
| 352 | |||
| 353 | =head1 AUTHOR | ||
| 354 | |||
| 355 | Hans Jeuken (hanje at cpan dot org) | ||
| 356 | |||
| 357 | =head1 TODO | ||
| 358 | |||
| 359 | =over 4 | ||
| 360 | |||
| 361 | =back | ||
| 362 | |||
| 363 | =head1 BUGS AND CAVEATS | ||
| 364 | |||
| 365 | If you find any bugs, please report them here L<https://github.com/haje61/App-Codit/issues>. | ||
| 366 | |||
| 367 | =head1 SEE ALSO | ||
| 368 | |||
| 369 | =over 4 | ||
| 370 | |||
| 371 | =back | ||
| 372 | |||
| 373 | =cut | ||
| 374 | |||
| 375 | 1; | ||
| 376 |