SKPDFSynchronizer.h 3.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990
  1. //
  2. // SKPDFSynchronizer.h
  3. // Skim
  4. //
  5. // Created by Christiaan Hofman on 4/21/07.
  6. /*
  7. This software is Copyright (c) 2007-2018
  8. Christiaan Hofman. All rights reserved.
  9. Redistribution and use in source and binary forms, with or without
  10. modification, are permitted provided that the following conditions
  11. are met:
  12. - Redistributions of source code must retain the above copyright
  13. notice, this list of conditions and the following disclaimer.
  14. - Redistributions in binary form must reproduce the above copyright
  15. notice, this list of conditions and the following disclaimer in
  16. the documentation and/or other materials provided with the
  17. distribution.
  18. - Neither the name of Christiaan Hofman nor the names of any
  19. contributors may be used to endorse or promote products derived
  20. from this software without specific prior written permission.
  21. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  22. "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  23. LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  24. A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  25. OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  26. SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  27. LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  28. DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  29. THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  30. (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  31. OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  32. */
  33. #import <Cocoa/Cocoa.h>
  34. #import "synctex_parser.h"
  35. enum {
  36. SKPDFSynchronizerDefaultOptions = 0,
  37. SKPDFSynchronizerShowReadingBarMask = 1 << 0,
  38. SKPDFSynchronizerFlippedMask = 1 << 1,
  39. };
  40. @protocol SKPDFSynchronizerDelegate;
  41. @interface SKPDFSynchronizer : NSObject {
  42. id <SKPDFSynchronizerDelegate> delegate;
  43. dispatch_queue_t queue;
  44. dispatch_queue_t lockQueue;
  45. NSString *syncFileName;
  46. BOOL isPdfsync;
  47. NSFileManager *fileManager;
  48. NSMutableArray *pages;
  49. NSMapTable *lines;
  50. NSMapTable *filenames;
  51. synctex_scanner_p scanner;
  52. volatile int32_t shouldKeepRunning;
  53. }
  54. @property (nonatomic, strong) NSString *fileName;
  55. @property (nonatomic, strong) NSDate *lastModDate;
  56. @property (nonatomic, assign) id <SKPDFSynchronizerDelegate> delegate;
  57. @property (readonly) BOOL shouldKeepRunning;
  58. - (void)findFileAndLineForLocation:(NSPoint)point inRect:(NSRect)rect pageBounds:(NSRect)bounds atPageIndex:(NSUInteger)pageIndex;
  59. - (void)findPageAndLocationForLine:(NSInteger)line inFile:(NSString *)file options:(NSInteger)options;
  60. // this must be called to stop the DO server from running in the server thread
  61. - (void)terminate;
  62. @end
  63. @protocol SKPDFSynchronizerDelegate <NSObject>
  64. - (void)synchronizer:(SKPDFSynchronizer *)synchronizer foundLine:(NSInteger)line inFile:(NSString *)file;
  65. - (void)synchronizer:(SKPDFSynchronizer *)synchronizer foundLocation:(NSPoint)point atPageIndex:(NSUInteger)pageIndex options:(NSInteger)options;
  66. @end