Skip to content

Commit

Permalink
Sorry for the repo trashing, it was needed, binary were taking too mu…
Browse files Browse the repository at this point in the history
…ch space
  • Loading branch information
Twinside committed Aug 6, 2011
0 parents commit e52aacf
Show file tree
Hide file tree
Showing 16 changed files with 1,213 additions and 0 deletions.
Empty file added README
Empty file.
218 changes: 218 additions & 0 deletions doc/codeoverview.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,218 @@
*CodeOverview.txt* Hackish plugin to display file overview alongside gvim

CodeOverview plugin~

1. Code Overview description |CodeOverview|
1.1 Requirements |CodeOverviewRequirements|
1.2 OS X & Windows Installation |CodeOverviewWinOsx|
1.3 Linux Installation |CodeOverviewLinux|
1.4 Platform differences |CodeOverviewPlatformDifferences|
2. Usage Example |CodeOverviewSampleUsage|
3. Commands description |CodeOverviewCommands|
- |:ShowCodeOverview|
- |:HideCodeOverview|
- |:CodeOverviewNoAuto|
- |:CodeOverviewAuto|
- |:SnapshotFile|
- |:ToggleCodeOverview|

4. Configuration |CodeOverViewConfiguration|
- |g:code_overview_use_colorscheme|
- |g:code_overview_autostart|
- |g:codeoverview_autoupdate|
- |g:codeOverviewShowErrorLines|
- |g:codeOverviewMaxLineCount|

5. Change log |CodeOverviewChangelog|

==============================================================================
*CodeOverview*
1. Code Overview description~
*CodeOverviewRequirements*
1.1 Requirements~
For Windows :
- GVim 7.3
- Microsoft .net Framework 4.0
- Windows XP, Vista or 7

For Mac OS X:
- Mac OSX Snow leopard
- MacVim 7.3

For Linux:
- GVim 7.3
- Python 2.6
- Pygtk
- PyCairo
- xvkbd
- Linux Something
*CodeOverviewWinOsx*
1.2 OS X & Windows Installation~
Just unzip the plugin in ~/vimfiles or ~/.vim directory,
or in ~/vimfiles/bundle or ~/.vim/bundle for pathogen users.

*CodeOverviewLinux*
1.3 Linux Installation~
Unzip in ~/.vim or ~/.vim/bundle.

At this point, you can use CodeOverview without the scrolling
ability, by using the normal commands. To be able to use the scrolling
possibilities, you must invoke gvim the following way : >
gvim --echo-wid > /tmp/vimwinId
<
It's hackish, fragile, but it works. It's the only way I found to get back
the X Window Id of gvim, which is used to send back scroll commands.

*CodeOverviewPlatformDifferences*
1.4 Platform differences~
Sadly, due to the hackish implementation of the plugin, all platform are
not equal in term of features, let's summarize the differences :

| Linux | OS X |Windows
View rect | X | X | X
Scrolling | X | | X
Window Tracking | | | X


The view rect is the representation of the vim view in the overview,
supported on all platforms.

The scrolling represent the possibility to click in the overview and get
vim to jump on the clicked line.

The window tracking is the ability of the panel to follow the GVim window
and act like if it were part of it.

==============================================================================
*CodeOverviewSampleUsage*

2. Usage Example~

Once GVim is loaded, type : >
:ShowCodeOverview
<
To avoid using too much resources, you need to refresh manually with the >
:SnapshotFile
<
command, or if you want your view to be automatically updated regularly, just type
the following command : >
:CodeOverviewAuto
<
If the panel is not needed anymore, use >
:HideCodeOverview
<

==============================================================================
*CodeOverviewCommands* List of Code Overview commands

3. Code Overview commands~

*ShowCodeOverview* *:ShowCodeOverview* >
:ShowCodeOverview
<
Start the overview panel.

*HideCodeOverview* *:HideCodeOverview* >
:HideCodeOverview
<
Hide the overview panel and stop automatic overview generation (unless
configured otherwise).

*CodeOverviewNoAuto* *:CodeOverviewNoAuto* >
:CodeOverviewNoAuto
<
Disable automatic overview generation.

*CodeOverviewAuto* *:CodeOverviewAuto* >
:CodeOverviewAuto
<
Setup automatic overview generation. An overview generation will happen
on search, save, buffer change, window change, compilation via |:make|
or a search via |:grep|.

*SnapshotFile* *:SnapshotFile* >
:SnapshotFile
<
Refresh your current overview with an overview of the current file.

*ToggleCodeOverview* *:ToggleCodeOverview* >
:ToggleCodeOverview
<
Toggle between the heat map display and the normal view. In the heatmap
display, the pixels colors depend on the complexity of the nesting.

==============================================================================
*CodeOverViewConfiguration* Variables controlling code overview.

3. Configuration~
*g:code_overview_use_colorscheme* >
let g:code_overview_use_colorscheme = 1
<
To use the current color scheme for the
code view generation.
Default : 1

*g:code_overview_autostart* >
let g:code_overview_autostart = 1
<
To start the plugin directly at vim launch.
Default : 0 (no automatic launching)

*g:codeoverview_autoupdate* >
let g:codeoverview_autoupdate = 1
<
To automatically start automatic overview generation,
in other words |:CodeOverviewAuto| is called automatically
Otherwise you have to manually call |:SnapshotFile|
to update the view.
(disabled by default)

*g:codeOverviewShowErrorLines* >
let g:codeOverviewShowErrorLines = 1
<
To enable or disable error lines layered on the overview.
Default : 1 (enabled)

*g:codeOverviewMaxLineCount* >
let g:codeOverviewMaxLineCount = 10000
<
To avoid locking up GVim, you can provide a maximum
line count to avoid refresh for very huge file.
Default is 10000

==============================================================================
*CodeOverviewChangelog*

5. Changelog~
* 2.1 : Adding heatmap display
* 2.0 : Adding linux Version
Adding OSX Version
Added documentation
Added color from current colorscheme.

* 1.8 : Added option to start plugin automatically.
* 1.7 : Added condition to avoid loading very huge file.
* 1.6 : Handling of HUUUUUUGES file
* 1.5 : Update in stabilities for binaries.
* 1.4 : Big fix to allow maximization on Windows XP.
* 1.3.1: Fixed problem of path under Windows XP
Fixed problem of overview when file has no
name
* 1.3 : Fixed problem when executables are put in
Program Files (yeah, I mentioned to put it
in ~/vimfiles, whatever...)
* 1.2 : Added check for the version of gvim.
* 1.1 : fixed problem with globpath flag for not cutting-edge
vim.
* 1.0 : Original version

==============================================================================

Thanks~
- Amjidanutpan Rama : forcing me to test the plugin
under Windows XP.

==============================================================================
vim:tw=78:ts=8:ft=help:norl:

27 changes: 27 additions & 0 deletions doc/tags
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
:CodeOverviewAuto codeoverview.txt /*:CodeOverviewAuto*
:CodeOverviewNoAuto codeoverview.txt /*:CodeOverviewNoAuto*
:HideCodeOverview codeoverview.txt /*:HideCodeOverview*
:ShowCodeOverview codeoverview.txt /*:ShowCodeOverview*
:SnapshotFile codeoverview.txt /*:SnapshotFile*
:ToggleCodeOverview codeoverview.txt /*:ToggleCodeOverview*
CodeOverViewConfiguration codeoverview.txt /*CodeOverViewConfiguration*
CodeOverview codeoverview.txt /*CodeOverview*
CodeOverview.txt codeoverview.txt /*CodeOverview.txt*
CodeOverviewAuto codeoverview.txt /*CodeOverviewAuto*
CodeOverviewChangelog codeoverview.txt /*CodeOverviewChangelog*
CodeOverviewCommands codeoverview.txt /*CodeOverviewCommands*
CodeOverviewLinux codeoverview.txt /*CodeOverviewLinux*
CodeOverviewNoAuto codeoverview.txt /*CodeOverviewNoAuto*
CodeOverviewPlatformDifferences codeoverview.txt /*CodeOverviewPlatformDifferences*
CodeOverviewRequirements codeoverview.txt /*CodeOverviewRequirements*
CodeOverviewSampleUsage codeoverview.txt /*CodeOverviewSampleUsage*
CodeOverviewWinOsx codeoverview.txt /*CodeOverviewWinOsx*
HideCodeOverview codeoverview.txt /*HideCodeOverview*
ShowCodeOverview codeoverview.txt /*ShowCodeOverview*
SnapshotFile codeoverview.txt /*SnapshotFile*
ToggleCodeOverview codeoverview.txt /*ToggleCodeOverview*
g:codeOverviewMaxLineCount codeoverview.txt /*g:codeOverviewMaxLineCount*
g:codeOverviewShowErrorLines codeoverview.txt /*g:codeOverviewShowErrorLines*
g:code_overview_autostart codeoverview.txt /*g:code_overview_autostart*
g:code_overview_use_colorscheme codeoverview.txt /*g:code_overview_use_colorscheme*
g:codeoverview_autoupdate codeoverview.txt /*g:codeoverview_autoupdate*
1 change: 1 addition & 0 deletions ftdetect/codeoverview.vim
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
au BufNewFile,BufRead *.textcodeoverview setf codeoverview
46 changes: 46 additions & 0 deletions plugin/CodeOverMac.app/Contents/Info.plist
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
<plist version="1.0">
<dict>
<key>BuildMachineOSBuild</key>
<string>10J869</string>
<key>CFBundleDevelopmentRegion</key>
<string>English</string>
<key>CFBundleExecutable</key>
<string>CodeOverMac</string>
<key>CFBundleIdentifier</key>
<string>com.yourcompany.CodeOverMac</string>
<key>CFBundleInfoDictionaryVersion</key>
<string>6.0</string>
<key>CFBundleName</key>
<string>CodeOverMac</string>
<key>CFBundlePackageType</key>
<string>APPL</string>
<key>CFBundleShortVersionString</key>
<string>1.0</string>
<key>CFBundleSignature</key>
<string>????</string>
<key>CFBundleVersion</key>
<string>1</string>
<key>DTCompiler</key>
<string></string>
<key>DTPlatformBuild</key>
<string>4A304a</string>
<key>DTPlatformVersion</key>
<string>GM</string>
<key>DTSDKBuild</key>
<string>4A304a</string>
<key>DTSDKName</key>
<string>macosx10.6</string>
<key>DTXcode</key>
<string>0400</string>
<key>DTXcodeBuild</key>
<string>4A304a</string>
<key>LSMinimumSystemVersion</key>
<string>10.6</string>
<key>NSMainNibFile</key>
<string>MainMenu</string>
<key>NSPrincipalClass</key>
<string>NSApplication</string>
</dict>
</plist>
Binary file added plugin/CodeOverMac.app/Contents/MacOS/CodeOverMac
Binary file not shown.
1 change: 1 addition & 0 deletions plugin/CodeOverMac.app/Contents/PkgInfo
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
APPL????
Binary file not shown.
Binary file not shown.
Loading

0 comments on commit e52aacf

Please sign in to comment.