?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
bump product version to 4.1.6.2
[LibreOffice.git] / include / tools / gen.hxx
blobc1a1e359bccc86c2df75085e797fc9ba2de39395
1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2 /*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19 #ifndef _SV_GEN_HXX
20 #define _SV_GEN_HXX
21
22 #include "tools/toolsdllapi.h"
23 #include <tools/solar.h>
24
25 #include <limits.h>
26 #include <ostream>
27 #include <cstdlib>
28
29 class SvStream;
30
31 // Pair
32
33 class SAL_WARN_UNUSED Pair
34 {
35 public:
36 Pair();
37 Pair( long nA, long nB );
38
39 long A() const { return nA; }
40 long B() const { return nB; }
41
42 long& A() { return nA; }
43 long& B() { return nB; }
44
45 sal_Bool operator == ( const Pair& rPair ) const;
46 sal_Bool operator != ( const Pair& rPair ) const;
47
48 TOOLS_DLLPUBLIC friend SvStream& operator>>( SvStream& rIStream, Pair& rPair );
49 TOOLS_DLLPUBLIC friend SvStream& operator<<( SvStream& rOStream, const Pair& rPair );
50
51 protected:
52 long nA;
53 long nB;
54 };
55
56 inline Pair::Pair()
57 {
58 nA = nB = 0;
59 }
60
61 inline Pair::Pair( long _nA, long _nB )
62 {
63 Pair::nA = _nA;
64 Pair::nB = _nB;
65 }
66
67 inline sal_Bool Pair::operator == ( const Pair& rPair ) const
68 {
69 return ((nA == rPair.nA) && (nB == rPair.nB));
70 }
71
72 inline sal_Bool Pair::operator != ( const Pair& rPair ) const
73 {
74 return ((nA != rPair.nA) || (nB != rPair.nB));
75 }
76
77 // Point
78
79 class SAL_WARN_UNUSED Point : public Pair
80 {
81 public:
82 Point();
83 Point( long nX, long nY );
84
85 long X() const { return nA; }
86 long Y() const { return nB; }
87
88 long& X() { return nA; }
89 long& Y() { return nB; }
90
91 void Move( long nHorzMove, long nVertMove );
92 sal_Bool IsAbove( const Point& rPoint ) const;
93 sal_Bool IsBelow( const Point& rPoint ) const;
94 sal_Bool IsLeft( const Point& rPoint ) const;
95 sal_Bool IsRight( const Point& rPoint ) const;
96
97 Point& operator += ( const Point& rPoint );
98 Point& operator -= ( const Point& rPoint );
99 Point& operator *= ( const long nVal );
100 Point& operator /= ( const long nVal );
101
102 friend inline Point operator+( const Point &rVal1, const Point &rVal2 );
103 friend inline Point operator-( const Point &rVal1, const Point &rVal2 );
104 friend inline Point operator*( const Point &rVal1, const long nVal2 );
105 friend inline Point operator/( const Point &rVal1, const long nVal2 );
106
107 long getX() const { return X(); }
108 long getY() const { return Y(); }
109 void setX(long nX) { X() = nX; }
110 void setY(long nY) { Y() = nY; }
111 };
112
113 inline Point::Point()
114 {
115 }
116
117 inline Point::Point( long nX, long nY ) : Pair( nX, nY )
118 {
119 }
120
121 inline void Point::Move( long nHorzMove, long nVertMove )
122 {
123 nA += nHorzMove;
124 nB += nVertMove;
125 }
126
127 inline sal_Bool Point::IsAbove( const Point& rPoint ) const
128 {
129 return (nB > rPoint.nB);
130 }
131
132 inline sal_Bool Point::IsBelow( const Point& rPoint ) const
133 {
134 return (nB < rPoint.nB);
135 }
136
137 inline sal_Bool Point::IsLeft( const Point& rPoint ) const
138 {
139 return (nA < rPoint.nA);
140 }
141
142 inline sal_Bool Point::IsRight( const Point& rPoint ) const
143 {
144 return (nA > rPoint.nA);
145 }
146
147 inline Point& Point::operator += ( const Point& rPoint )
148 {
149 nA += rPoint.nA;
150 nB += rPoint.nB;
151 return *this;
152 }
153
154 inline Point& Point::operator -= ( const Point& rPoint )
155 {
156 nA -= rPoint.nA;
157 nB -= rPoint.nB;
158 return *this;
159 }
160
161 inline Point& Point::operator *= ( const long nVal )
162 {
163 nA *= nVal;
164 nB *= nVal;
165 return *this;
166 }
167
168 inline Point& Point::operator /= ( const long nVal )
169 {
170 nA /= nVal;
171 nB /= nVal;
172 return *this;
173 }
174
175 inline Point operator+( const Point &rVal1, const Point &rVal2 )
176 {
177 return Point( rVal1.nA+rVal2.nA, rVal1.nB+rVal2.nB );
178 }
179
180 inline Point operator-( const Point &rVal1, const Point &rVal2 )
181 {
182 return Point( rVal1.nA-rVal2.nA, rVal1.nB-rVal2.nB );
183 }
184
185 inline Point operator*( const Point &rVal1, const long nVal2 )
186 {
187 return Point( rVal1.nA*nVal2, rVal1.nB*nVal2 );
188 }
189
190 inline Point operator/( const Point &rVal1, const long nVal2 )
191 {
192 return Point( rVal1.nA/nVal2, rVal1.nB/nVal2 );
193 }
194
195 template< typename charT, typename traits >
196 inline std::basic_ostream<charT, traits> & operator <<(
197 std::basic_ostream<charT, traits> & stream, const Point& point )
198 {
199 return stream << point.X() << ',' << point.Y();
200 }
201
202 // Size
203
204 class SAL_WARN_UNUSED Size : public Pair
205 {
206 public:
207 Size();
208 Size( long nWidth, long nHeight );
209
210 long Width() const { return nA; }
211 long Height() const { return nB; }
212
213 long& Width() { return nA; }
214 long& Height() { return nB; }
215
216 long getWidth() const { return Width(); }
217 long getHeight() const { return Height(); }
218 void setWidth(long nWidth) { Width() = nWidth; }
219 void setHeight(long nHeight) { Height() = nHeight; }
220 };
221
222 inline Size::Size()
223 {
224 }
225
226 inline Size::Size( long nWidth, long nHeight ) :
227 Pair( nWidth, nHeight )
228 {
229 }
230
231 template< typename charT, typename traits >
232 inline std::basic_ostream<charT, traits> & operator <<(
233 std::basic_ostream<charT, traits> & stream, const Size& size )
234 {
235 return stream << size.Width() << 'x' << size.Height();
236 }
237
238 // Range
239
240 #define RANGE_MAX LONG_MAX
241
242 class SAL_WARN_UNUSED Range : public Pair
243 {
244 public:
245 Range();
246 Range( long nMin, long nMax );
247
248 long Min() const { return nA; }
249 long Max() const { return nB; }
250 long Len() const { return nB - nA + 1; }
251
252 long& Min() { return nA; }
253 long& Max() { return nB; }
254
255 sal_Bool IsInside( long nIs ) const;
256
257 void Justify();
258 };
259
260 inline Range::Range()
261 {
262 }
263
264 inline Range::Range( long nMin, long nMax ) : Pair( nMin, nMax )
265 {
266 }
267
268 inline sal_Bool Range::IsInside( long nIs ) const
269 {
270 return ((nA <= nIs) && (nIs <= nB ));
271 }
272
273 inline void Range::Justify()
274 {
275 if ( nA > nB )
276 {
277 long nHelp = nA;
278 nA = nB;
279 nB = nHelp;
280 }
281 }
282
283 template< typename charT, typename traits >
284 inline std::basic_ostream<charT, traits> & operator <<(
285 std::basic_ostream<charT, traits> & stream, const Range& range )
286 {
287 return stream << range.Min() << '-' << range.Max();
288 }
289
290 // Selection
291
292 #define SELECTION_MIN LONG_MIN
293 #define SELECTION_MAX LONG_MAX
294
295 class SAL_WARN_UNUSED Selection : public Pair
296 {
297 public:
298 Selection();
299 Selection( long nPos );
300 Selection( long nMin, long nMax );
301
302 long Min() const { return nA; }
303 long Max() const { return nB; }
304 long Len() const { return nB - nA; }
305
306 long& Min() { return nA; }
307 long& Max() { return nB; }
308
309 sal_Bool IsInside( long nIs ) const;
310
311 void Justify();
312
313 sal_Bool operator !() const { return !Len(); }
314
315 long getMin() const { return Min(); }
316 long getMax() const { return Max(); }
317 void setMin(long nMin) { Min() = nMin; }
318 void setMax(long nMax) { Max() = nMax; }
319 };
320
321 inline Selection::Selection()
322 {
323 }
324
325 inline Selection::Selection( long nPos ) : Pair( nPos, nPos )
326 {
327 }
328
329 inline Selection::Selection( long nMin, long nMax ) :
330 Pair( nMin, nMax )
331 {
332 }
333
334 inline sal_Bool Selection::IsInside( long nIs ) const
335 {
336 return ((nA <= nIs) && (nIs < nB ));
337 }
338
339 inline void Selection::Justify()
340 {
341 if ( nA > nB )
342 {
343 long nHelp = nA;
344 nA = nB;
345 nB = nHelp;
346 }
347 }
348
349 template< typename charT, typename traits >
350 inline std::basic_ostream<charT, traits> & operator <<(
351 std::basic_ostream<charT, traits> & stream, const Selection& selection )
352 {
353 return stream << selection.Min() << '-' << selection.Max();
354 }
355 // Rectangle
356
357 #define RECT_EMPTY ((short)-32767)
358
359 class TOOLS_DLLPUBLIC SAL_WARN_UNUSED Rectangle
360 {
361 public:
362 Rectangle();
363 Rectangle( const Point& rLT, const Point& rRB );
364 Rectangle( long nLeft, long nTop,
365 long nRight, long nBottom );
366 Rectangle( const Point& rLT, const Size& rSize );
367
368 long Left() const { return nLeft; }
369 long Right() const { return nRight; }
370 long Top() const { return nTop; }
371 long Bottom() const { return nBottom; }
372
373 long& Left() { return nLeft; }
374 long& Right() { return nRight; }
375 long& Top() { return nTop; }
376 long& Bottom() { return nBottom; }
377
378 inline Point TopLeft() const;
379 inline Point TopRight() const;
380 inline Point TopCenter() const;
381 inline Point BottomLeft() const;
382 inline Point BottomRight() const;
383 inline Point BottomCenter() const;
384 inline Point LeftCenter() const;
385 inline Point RightCenter() const;
386 inline Point Center() const;
387
388 inline void Move( long nHorzMove, long nVertMove );
389 inline void Transpose();
390 inline void SetPos( const Point& rPoint );
391 void SetSize( const Size& rSize );
392 inline Size GetSize() const;
393
394 inline long GetWidth() const;
395 inline long GetHeight() const;
396
397 Rectangle& Union( const Rectangle& rRect );
398 Rectangle& Intersection( const Rectangle& rRect );
399 inline Rectangle GetUnion( const Rectangle& rRect ) const;
400 inline Rectangle GetIntersection( const Rectangle& rRect ) const;
401
402 void Justify();
403
404 sal_Bool IsInside( const Point& rPOINT ) const;
405 sal_Bool IsInside( const Rectangle& rRect ) const;
406 sal_Bool IsOver( const Rectangle& rRect ) const;
407
408 void SetEmpty() { nRight = nBottom = RECT_EMPTY; }
409 inline sal_Bool IsEmpty() const;
410
411 inline sal_Bool operator == ( const Rectangle& rRect ) const;
412 inline sal_Bool operator != ( const Rectangle& rRect ) const;
413
414 inline Rectangle& operator += ( const Point& rPt );
415 inline Rectangle& operator -= ( const Point& rPt );
416
417 friend inline Rectangle operator + ( const Rectangle& rRect, const Point& rPt );
418 friend inline Rectangle operator - ( const Rectangle& rRect, const Point& rPt );
419
420 TOOLS_DLLPUBLIC friend SvStream& operator>>( SvStream& rIStream, Rectangle& rRect );
421 TOOLS_DLLPUBLIC friend SvStream& operator<<( SvStream& rOStream, const Rectangle& rRect );
422
423 // ONE
424 long getX() const { return nLeft; }
425 long getY() const { return nTop; }
426 long getWidth() const { return nRight - nLeft; }
427 long getHeight() const { return nBottom - nTop; }
428 void setX( long n ) { nRight += n-nLeft; nLeft = n; }
429 void setY( long n ) { nBottom += n-nTop; nTop = n; }
430 void setWidth( long n ) { nRight = nLeft + n; }
431 void setHeight( long n ) { nBottom = nTop + n; }
432
433 private:
434 long nLeft;
435 long nTop;
436 long nRight;
437 long nBottom;
438 };
439
440 inline Rectangle::Rectangle()
441 {
442 nLeft = nTop = 0;
443 nRight = nBottom = RECT_EMPTY;
444 }
445
446 inline Rectangle::Rectangle( const Point& rLT, const Point& rRB )
447 {
448 nLeft = rLT.X();
449 nTop = rLT.Y();
450 nRight = rRB.X();
451 nBottom = rRB.Y();
452 }
453
454 inline Rectangle::Rectangle( long _nLeft, long _nTop,
455 long _nRight, long _nBottom )
456 {
457 nLeft = _nLeft;
458 nTop = _nTop;
459 nRight = _nRight;
460 nBottom = _nBottom;
461 }
462
463 inline Rectangle::Rectangle( const Point& rLT, const Size& rSize )
464 {
465 nLeft = rLT.X();
466 nTop = rLT.Y();
467 nRight = rSize.Width() ? nLeft+rSize.Width()-1 : RECT_EMPTY;
468 nBottom = rSize.Height() ? nTop+rSize.Height()-1 : RECT_EMPTY;
469 }
470
471 inline sal_Bool Rectangle::IsEmpty() const
472 {
473 return ((nRight == RECT_EMPTY) || (nBottom == RECT_EMPTY));
474 }
475
476 inline Point Rectangle::TopLeft() const
477 {
478 return Point( nLeft, nTop );
479 }
480
481 inline Point Rectangle::TopRight() const
482 {
483 return Point( (nRight == RECT_EMPTY) ? nLeft : nRight, nTop );
484 }
485
486 inline Point Rectangle::BottomLeft() const
487 {
488 return Point( nLeft, (nBottom == RECT_EMPTY) ? nTop : nBottom );
489 }
490
491 inline Point Rectangle::BottomRight() const
492 {
493 return Point( (nRight == RECT_EMPTY) ? nLeft : nRight,
494 (nBottom == RECT_EMPTY) ? nTop : nBottom );
495 }
496
497 inline Point Rectangle::TopCenter() const
498 {
499 if ( IsEmpty() )
500 return Point( nLeft, nTop );
501 else
502 return Point( std::min( nLeft, nRight ) + std::abs( (nRight - nLeft)/2 ),
503 std::min( nTop, nBottom) );
504 }
505
506 inline Point Rectangle::BottomCenter() const
507 {
508 if ( IsEmpty() )
509 return Point( nLeft, nTop );
510 else
511 return Point( std::min( nLeft, nRight ) + std::abs( (nRight - nLeft)/2 ),
512 std::max( nTop, nBottom) );
513 }
514
515 inline Point Rectangle::LeftCenter() const
516 {
517 if ( IsEmpty() )
518 return Point( nLeft, nTop );
519 else
520 return Point( std::min( nLeft, nRight ), nTop + (nBottom - nTop)/2 );
521 }
522
523 inline Point Rectangle::RightCenter() const
524 {
525 if ( IsEmpty() )
526 return Point( nLeft, nTop );
527 else
528 return Point( std::max( nLeft, nRight ), nTop + (nBottom - nTop)/2 );
529 }
530
531 inline Point Rectangle::Center() const
532 {
533 if ( IsEmpty() )
534 return Point( nLeft, nTop );
535 else
536 return Point( nLeft+(nRight-nLeft)/2 , nTop+(nBottom-nTop)/2 );
537 }
538
539 inline void Rectangle::Move( long nHorzMove, long nVertMove )
540 {
541 nLeft += nHorzMove;
542 nTop += nVertMove;
543 if ( nRight != RECT_EMPTY )
544 nRight += nHorzMove;
545 if ( nBottom != RECT_EMPTY )
546 nBottom += nVertMove;
547 }
548
549 void Rectangle::Transpose()
550 {
551 if ( !IsEmpty() )
552 {
553 long swap( nLeft );
554 nLeft = nTop;
555 nTop = swap;
556
557 swap = nRight;
558 nRight = nBottom;
559 nBottom = swap;
560 }
561 }
562
563 inline void Rectangle::SetPos( const Point& rPoint )
564 {
565 if ( nRight != RECT_EMPTY )
566 nRight += rPoint.X() - nLeft;
567 if ( nBottom != RECT_EMPTY )
568 nBottom += rPoint.Y() - nTop;
569 nLeft = rPoint.X();
570 nTop = rPoint.Y();
571 }
572
573 inline long Rectangle::GetWidth() const
574 {
575 long n;
576 if ( nRight == RECT_EMPTY )
577 n = 0;
578 else
579 {
580 n = nRight - nLeft;
581 if( n < 0 )
582 n--;
583 else
584 n++;
585 }
586
587 return n;
588 }
589
590 inline long Rectangle::GetHeight() const
591 {
592 long n;
593 if ( nBottom == RECT_EMPTY )
594 n = 0;
595 else
596 {
597 n = nBottom - nTop;
598 if ( n < 0 )
599 n--;
600 else
601 n++;
602 }
603
604 return n;
605 }
606
607 inline Size Rectangle::GetSize() const
608 {
609 return Size( GetWidth(), GetHeight() );
610 }
611
612 inline Rectangle Rectangle::GetUnion( const Rectangle& rRect ) const
613 {
614 Rectangle aTmpRect( *this );
615 return aTmpRect.Union( rRect );
616 }
617
618 inline Rectangle Rectangle::GetIntersection( const Rectangle& rRect ) const
619 {
620 Rectangle aTmpRect( *this );
621 return aTmpRect.Intersection( rRect );
622 }
623
624 inline sal_Bool Rectangle::operator == ( const Rectangle& rRect ) const
625 {
626 return ((nLeft == rRect.nLeft ) &&
627 (nTop == rRect.nTop ) &&
628 (nRight == rRect.nRight ) &&
629 (nBottom == rRect.nBottom ));
630 }
631
632 inline sal_Bool Rectangle::operator != ( const Rectangle& rRect ) const
633 {
634 return ((nLeft != rRect.nLeft ) ||
635 (nTop != rRect.nTop ) ||
636 (nRight != rRect.nRight ) ||
637 (nBottom != rRect.nBottom ));
638 }
639
640 inline Rectangle& Rectangle::operator +=( const Point& rPt )
641 {
642 nLeft += rPt.X();
643 nTop += rPt.Y();
644 if ( nRight != RECT_EMPTY )
645 nRight += rPt.X();
646 if ( nBottom != RECT_EMPTY )
647 nBottom += rPt.Y();
648 return *this;
649 }
650
651 inline Rectangle& Rectangle::operator -= ( const Point& rPt )
652 {
653 nLeft -= rPt.X();
654 nTop -= rPt.Y();
655 if ( nRight != RECT_EMPTY )
656 nRight -= rPt.X();
657 if ( nBottom != RECT_EMPTY )
658 nBottom -= rPt.Y();
659 return *this;
660 }
661
662 inline Rectangle operator + ( const Rectangle& rRect, const Point& rPt )
663 {
664 Rectangle aRect( rRect.nLeft + rPt.X(), rRect.nTop + rPt.Y(),
665 (rRect.nRight == RECT_EMPTY) ? RECT_EMPTY : rRect.nRight + rPt.X(),
666 (rRect.nBottom == RECT_EMPTY) ? RECT_EMPTY : rRect.nBottom + rPt.Y() );
667 return aRect;
668 }
669
670 inline Rectangle operator - ( const Rectangle& rRect, const Point& rPt )
671 {
672 Rectangle aRect( rRect.nLeft - rPt.X(),
673 rRect.nTop - rPt.Y(),
674 (rRect.nRight == RECT_EMPTY) ? RECT_EMPTY : rRect.nRight - rPt.X(),
675 (rRect.nBottom == RECT_EMPTY) ? RECT_EMPTY : rRect.nBottom - rPt.Y() );
676 return aRect;
677 }
678
679 template< typename charT, typename traits >
680 inline std::basic_ostream<charT, traits> & operator <<(
681 std::basic_ostream<charT, traits> & stream, const Rectangle& rectangle )
682 {
683 if (rectangle.IsEmpty())
684 return stream << "EMPTY";
685 else
686 return stream << rectangle.getWidth() << 'x' << rectangle.getHeight()
687 << "@(" << rectangle.getX() << ',' << rectangle.getY() << ")";
688 }
689
690 #endif
691
692 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
FREE OFFICE SUITE